IListManager::SetDesc Method [C++]

Use this method to provide a new description for a list.

Definition

[C++]

HRESULT IListManager::SetDesc(VARIANTlistID,
 BSTRnewListDesc);

[Visual Basic]

Sub SetDesc(listID As Variant,
 newListDesc As String)

Parameters

• listID[C++]
  [in] A VARIANT that specifies the ID or name of the list.
• listID[Visual Basic]
  A Variant that specifies the ID or name of the list.
• newListDesc[C++]
  [in] A BSTR that contains the description to be associated with the list.
• newListDesc[Visual Basic]
  A String that contains the description to be associated with the list.

[C++]

Return Values

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

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.

[Visual Basic]

Example

oListManager.SetDesc(listID, newListDesc)

See Also

[C++]ListManager Object

[Visual Basic]ListManager Object

Copyright © 2005 Microsoft Corporation.
All rights reserved.