IProductCatalog3::GetProductVariant Method [C++]

Use this method to retrieve the properties of a specified product variant.

Definition

[C++]

HRESULT IProductCatalog3::GetProductVariant(VARIANTvarProductID,
 VARIANTvarVariantID,
 _Recordset**ppRSVariant);

[Visual Basic]

Function GetProductVariant(varProductID As Variant,
 varVariantID As Variant) As _Recordset

Parameters

• varProductID[C++]
  [in] A VARIANT that contains the unique identifier of the product family.
• varProductID[Visual Basic]
  A Variant that contains the unique identifier of the product family.
• varVariantID[C++]
  [in] A VARIANT that contains the unique identifier of the product variant.
• varVariantID[Visual Basic]
  A Variant that contains the unique identifier of the product variant.
• ppRSVariant[C++]
  [out, retval] A pointer to hold the reference to the returned Recordset object, which will contain the properties of the variant.

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 that contains the properties of the specified variant.

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 ppRSVariant parameter contains valid data only if the method was accessed successfully.

A single row recordset with all the properties of the variant is returned. The fields of the returned recordset are determined by the properties associated with the definition on which it is based. Both the product properties and the variant properties are returned.

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

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

[Visual Basic]

Example

SET rsVariantProps = myProductCatalog.GetProductVariant("SKU4007", "Blue")

See Also

[C++]ProductCatalog Object

[Visual Basic]ProductCatalog Object

[C++]IProductCatalog3::get_IdentifyingVariantProperty

[Visual Basic]ProductCatalog.IdentifyingVariantProperty

Copyright © 2005 Microsoft Corporation.
All rights reserved.