Share via

_Catalogsets2::UpdateCatalogSet Method [C++]

  • Article

Use this method to update an existing catalog set and its basic properties.

Definition

[C++]

HRESULT _Catalogsets2::UpdateCatalogSet(BSTRCatalogSetID,
  BSTRCatalogSetName,
  BSTRCatalogSetDescription,
  VARIANT_BOOLbWildCard,
  _Recordset*CatalogNamesRS);

[Visual Basic]

Sub UpdateCatalogSet(CatalogSetID As String,
  CatalogSetName As String,
  CatalogSetDescription As String,
  bWildCard As Boolean,
  Optional CatalogNamesRS As Recordset)

Parameters

[C++]

  • CatalogSetID
    [in] A BSTR that contains the catalog set ID (GUID).
  • CatalogSetName
    [in] A BSTR that contains the catalog set name. The maximum length is 128 characters.
  • CatalogSetDescription
    [in] A BSTR that contains the catalog set description.
  • bWildCard
    [in] A VARIANT_BOOL that indicates which catalogs to use. A value of TRUE indicates use all catalogs. A value of FALSE indicates use the catalogs contained in the CatalogNameRS parameter.
  • CatalogNamesRS
    [in, optional] A reference to a _Recordset object that contains the catalog names.

[Visual Basic]

  • CatalogSetID
    A String that contains the catalog set ID (GUID).
  • CatalogSetName
    A String that contains the catalog set name. The maximum length is 128 characters.
  • CatalogSetDescription
    A String that contains the catalog set description.
  • bWildCard
    A Boolean that indicates which catalogs to use. A value of True indicates use all catalogs. A value of False indicates use the catalogs contained in the CatalogNameRS parameter.
  • CatalogNamesRS
    A Recordset object that contains the catalog names.

Return Values

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

[Visual Basic] None.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. 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] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

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

[Visual Basic]

Example

'strCatalogSetID is the GUID for the CatalogSet.
'rsCatalogNames is a Recordset as described in the parameter description.

myCatalogsets2.UpdateCatalogSet strCatalogSetID, "Clothing", "All soft goods", FALSE, rsCatalogNames

See Also

[C++]Catalogsets2 Object

[Visual Basic]Catalogsets2 Object

Copyright © 2005 Microsoft Corporation.
All rights reserved.