IProductCatalog3::GetVirtualCatalogRules Method [C++]

Use this method to return a recordset containing the specified virtual catalog rules.

Definition

[C++]

HRESULT IProductCatalog3::GetVirtualCatalogRules(VARIANTlStartingRecord,
  VARIANTlRecordsToRetrieve,
  VARIANTstrPropertyToSortOn,
  VARIANT_BOOLfSortAscending,
  VARIANT*plTotalRecordsInQuery,
  _Recordset**ppRSProductRules);

[Visual Basic]

Function GetVirtualCatalogRules(Optional lStartingRecord As Variant,
  Optional lRecordsToRetrieve As Variant,
  Optional strPropertyToSortOn As Variant,
  Optional fSortAscending As Boolean,
  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.
• strPropertyToSortOn[C++]
  [in, optional] A VARIANT that contains the property on which to sort. This must be a property in the returned recordset.
• strPropertyToSortOn[Visual Basic]
  A Variant that contains the property on which to sort. This must be a property in the returned recordset.
• fSortAscending[C++]
  [in, optional, defaultvalue (-1)] A VARIANT_BOOL that specifies whether to sort in ascending or descending order. A value of True (-1) indicates to sort in ascending order. A value of False (0) indicates to sort in descending order.
• fSortAscending[Visual Basic]
  A Boolean that specifies whether to sort in ascending or descending order. A value of True (-1) indicates to sort in ascending order. A value of False (0) indicates to sort in descending order. The default value is True.
• 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.
• ppRSProductRules[C++]
  [out, retval] A pointer to hold the reference to the returned Recordset object, which will contain the virtual catalog rules.

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 virtual catalog rules.

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.

Remarks

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

The returned recordset is disconnected and updateable. The following table shows the fields that the returned recordset contains.

The following table shows the enumeration that indicates the rule types in the returned recordset.

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

[Visual Basic]

Example

vTotalRecords is a variant.
SET rsRules = myProductCatalog.GetVirtualCatalogRules(1, 25, strPropertyToSortOn, True, vTotalRecords )

See Also

[C++]ProductCatalog Object

[Visual Basic]ProductCatalog Object

Copyright © 2005 Microsoft Corporation.
All rights reserved.