Share via


IListManager::GetListFlags

Ee811371.c++_off(en-US,CS.10).gifEe811371.vb_on(en-US,CS.10).gif

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

Definition

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

Parameters

listID

[in] A VARIANT that contains the ID or name of the list.

plFlags

[out, retval] A pointer to a long used to return the flags attribute.

Return Values

This method returns an HRESULT indicating whether or not it completed successfully. See the Error Values section for more details.

Error Values

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.

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

Constant Value Description
E_LM_LIST_NOT_FOUND 0x8C400006 The specified list does not exist.
E_LM_SQLERROR 0x8C400003 Error while executing SQL/ADO operation.
OLE_E_BLANK 0x80040007 The ListManager object has not been properly initialized.

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.

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.

Type Value Description
DEFAULT 0x0 A Mailing list
HIDDEN 0x1 The list should not be exposed in the user interface
DYNAMIC 0x2 A dynamic list
USER 0x4 A User list (contains an rcp_guid column)
GENERIC 0x8 A Generic list
MAILABLE 0x10 A Mailable list (contains an rcp_email column)

See Also

ListManager Object


All rights reserved.