IProductCatalog::GetProductVariant

Ee798113.c++_off(en-US,CS.10).gifEe798113.vb_on(en-US,CS.10).gif

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

Definition

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

Parameters

varProductID

[in] A VARIANT that contains the unique identifier of the product family.

varVariantID

[in] A VARIANT that contains the unique identifier of the product variant.

ppRSVariant

[out, retval] A pointer to hold the reference to the returned Recordset object, which will contain the properties of the variant.

Return Values

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

Error Values

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.

The following table shows the custom COM errors that this method can return.

Constant Value Description
E_CAT_CATALOG_DOESNT_SUPPORT_VARIANTS 0x88980032 This catalog does not support variants. This is determined when the catalog is created and cannot be changed.

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.

Remarks

The ppRSVariant parameter contains valid data only if the property 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.

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

See Also

ProductCatalog Object

IProductCatalog::get_IdentifyingVariantProperty


All rights reserved.