IListManager::GetListUserFlags Method [C++]

Article
11/12/2009

Use this method to retrieve the UserFlags attribute for a list.

Definition

[C++]

HRESULT IListManager::GetListUserFlags(VARIANTlistID,
 long*plUserFlags);

[Visual Basic]

Function GetListUserFlags(listID As Variant) As long

Parameters

listID[C++]
[in] A VARIANT that contains the ID or name of the list.
listID[Visual Basic]
A Variant that contains the ID of the ID or name of the list.
plUserFlags[C++]
[out, retval] A pointer to a long used to return the UserFlags attribute.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] If this method completes successfully, it returns a Long that contains the UserFlags attribute.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and either standard or custom COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to either standard or custom COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.

The following table shows the custom COM errors that this method can return.

Constant	Value	Description
E_LM_LIST_NOT_FOUND	[C++] 0x8C400006 [Visual Basic] &H8C400006	The specified list does not exist.
E_LM_SQLERROR	[C++] 0x8C400003 [Visual Basic] &H8C400003	Error while executing SQL/ADO operation.
OLE_E_BLANK	[C++] 0x80040007 [Visual Basic] &H80040007	The ListManager object has not been properly initialized.

[C++] Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

The UserFlags attributes are for use by applications external to the List Manager. The List Manager merely stores the flags that were passed in at the time a list was created and does not interpret the UserFlags attributes value in any way.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.