IProductCatalog3::GetDependentCatalogs Method [C++]

Use this method to return a recordset with a single field containing all of the virtual catalogs that are dependant on this catalog. This method cannot be called on a virtual catalog.

Definition

[C++]

HRESULT IProductCatalog3::GetDependentCatalogs(VARIANTlStartingRecord,
  VARIANTlRecordsToRetrieve,
  VARIANT*plTotalRecordsInQuery,
  _Recordset**ppRSDependentCatalogs);

[Visual Basic]

Function GetDependentCatalogs(Optional lStartingRecord As Variant,
  Optional lRecordsToRetrieve As Variant,
  Optional plTotalRecordsInQuery As Variant) As _Recordset

Parameters

• lStartingRecord[C++]
  [in, optional] A VARIANT that contains the starting record number. A value of one (1) indicates the first record. If the starting record number is not specified, then this method starts with record one (1).
• lStartingRecord[Visual Basic]
  A Variant that contains the starting record number. A value of one (1) indicates the first record. If the starting record number is not specified, then this method starts with record one (1).
• lRecordsToRetrieve[C++]
  [in, optional] A VARIANT that contains the number of records to retrieve.
• lRecordsToRetrieve[Visual Basic]
  A Variant that contains the number of records to retrieve.
• plTotalRecordsInQuery[C++]
  [in, out, optional] A pointer to a VARIANT that, if supplied, contains on output the total number of records.
• plTotalRecordsInQuery[Visual Basic]
  A Variant that, if supplied, contains on output the total number of records.
• ppRSDependentCatalogs[C++]
  [out, retval] A pointer to hold the reference to the returned Recordset object, which will contain the dependent catalogs.

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 Recordset object that contains the dependent catalogs.

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 error 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.

Remarks

[C++] The ppRSDependentCatalogs parameter contains valid data only if the method was accessed successfully.

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

[Visual Basic]

Example

x = myProductCatalog.GetDependentCatalogs(lStartingRecord, lRecordsToRetrieve, plTotalRecordsInQuery)

See Also

[C++]ProductCatalog Object

[Visual Basic]ProductCatalog Object

Copyright © 2005 Microsoft Corporation.
All rights reserved.