Share via


IListManager::GetListProperty

Ee826091.c++_off(en-US,CS.10).gifEe826091.vb_on(en-US,CS.10).gif

Use this method to retrieve a property of a list.

Definition

HRESULT IListManager::GetListProperty(VARIANTlistID,BSTRlistPropertyName,VARIANT*pvarListProp);

Parameters

listID

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

listPropertyName

[in] A BSTR that contains the property name (column of the lm_master table).

pvarListProp

[out, retval] A pointer to a VARIANT used to return the value of the property.

Return Values

This method returns an HRESULT indicating whether 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

For information about the available list properties, see IListManager::GetLists.

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

See Also

ListManager Object


All rights reserved.