Share via


IProductCatalog3::get_IdentifyingProductProperty Property [C++]

The IdentifyingProductProperty property is a read-only String that contains the name of the unique identifier field for the products in this catalog.

Definition

[C++]

HRESULT IProductCatalog3::get_IdentifyingProductProperty(BSTR*IdentifyingProductProperty);

[Visual Basic]

Property IdentifyingProductProperty As String

Parameters

  • IdentifyingProductProperty[C++]
    [out, retval] A BSTR used to return the name of the identifying product property.

[Visual Basic] None.

[C++]

Return Values

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

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

The following table describes the custom COM errors this property can return.

Constant Value Description
E_INVALIDARG

[C++] 0x80070057

[Visual Basic] &H80070057

One or more arguments are invalid.
E_OUTOFMEMORY

[C++] 0x8007000E

[Visual Basic] &H8007000E

Out of memory.

Remarks

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

The value of this property will always be "ProductID" for a virtual catalog.

The product ID is cached in the ProductCatalog object. Because of the cache, this method will continue to return the old value after the catalog has been deleted.

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

See Also

[C++]ProductCatalog Object

[Visual Basic]ProductCatalog Object

[C++]IProductCatalog3::get_IdentifyingVariantProperty

[Visual Basic]ProductCatalog.IdentifyingVariantProperty

Copyright © 2005 Microsoft Corporation.
All rights reserved.