IListManager::GetListFlags Method [C++]

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

Definition

[C++]

HRESULT IListManager::GetListFlags(VARIANTlistID,
 long*plFlags);

[Visual Basic]

Function GetListFlags(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.
• plFlags[C++]
  [out, retval] A pointer to a long used to return the flags 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 flags 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.

[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 following table lists the possible flag parameter values used to determine the type of list created. Values may be OR'ed together to specify more than one flag.

See Also

[C++]ListManager Object

[Visual Basic]ListManager Object

Copyright © 2005 Microsoft Corporation.
All rights reserved.