IListManager::GetListProperty Method [C++]

Use this method to retrieve a property of a list.

Definition

[C++]

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

[Visual Basic]

Function GetListProperty(listID As Variant,
  listPropertyName As String) As Variant

Parameters

  • listID[C++]
    [in] A VARIANT that contains the ID or name of the list.
  • listID[Visual Basic]
    A Variant that contains the ID or name of the list.
  • listPropertyName[C++]
    [in] A BSTR that contains the property name (column of the lm_master table).
  • listPropertyName[Visual Basic]
    A String that contains the property name (column of the lm_master table).
  • pvarListProp[C++]
    [out, retval] A pointer to a VARIANT used to return the value of the property.

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 Variant containing the value of the property.

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

[C++] For information about the available list properties, see IListManager::GetLists.

[Visual Basic] For information about the available list properties, see ListManager.GetLists.

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

[Visual Basic]

Example

' vSource is a Variant
vSource = _
 oListManager.GetListProperty("{454799A2-312B-4F5F-90A0-F514FBA0EC5A}", _
 "list_source")

See Also

[C++]ListManager Object

[Visual Basic]ListManager Object

Copyright © 2005 Microsoft Corporation.
All rights reserved.