ICatalogManager3::AddDefinitionVariantProperty Method [C++]

Article
11/12/2009

Use this method to add a variant property to a definition. This method is similar to the AddDefinitionProperty method. The properties added with this method will only be used by product variants.

Definition

[C++]

HRESULT ICatalogManager3::AddDefinitionVariantProperty(BSTRstrDefinitionName,
  BSTRstrPropertyName);

[Visual Basic]

Sub AddDefinitionVariantProperty(strDefinitionName As String,
  strPropertyName As String)

Parameters

strDefinitionName[C++]
[in] A BSTR that contains the name of the definition to which the specified variant property will be added.
strDefinitionName[Visual Basic]
A String that contains the name of the definition to which the specified variant property will be added.
strPropertyName[C++]
[in] A BSTR that contains the name of the property to be added to the specified definition.
strPropertyName[Visual Basic]
A String that contains the name of the property to be added to the specified definition.

Return Values

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

[Visual Basic] None.

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.

Name	Value	Description
E_CAT_CATMGR_NOT_INITIALIZED	[C++] 0x889800B [Visual Basic] &H8898005	The CatalogManager object has not been initialized. The CatalogManager object should be initialized before calling this method.
E_CAT_INVALID_DEFINITION_LENGTH	[C++] 0x889800E [Visual Basic] &H889800A	The definition name that you specified is invalid. Definition names should be between 1 and 128 characters in length.
E_CAT_INVALID_PROPERTY_NAME	[C++] 0x889800A [Visual Basic] &H8898002	The property name you specified is invalid. Property names cannot be blank and cannot exceed 100 characters. Property names cannot begin with a digit and cannot contain one of the following five reserved characters .,"[]
E_CAT_DEFINITION_DOESNT_EXIST	[C++] 0x8898000 [Visual Basic] &H889800B	The definition you specified does not exist.
E_CAT_PROP_DOESNT_EXIST	[C++] 0x8898000 [Visual Basic] &H8898005	The property name you specified does not exist.
E_CAT_PROP_IN_DEFINITION	[C++] 0x8898000 [Visual Basic] &H889800D	The property you specified is already part of that definition.
E_CAT_ERROR_VARIANT_PROP	[C++] 0x889800A [Visual Basic] &H8898003	A variant property cannot be added to a category definition.

[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

This method adds a variant property to a definition. Any product variants created from the definition will also have the property. A property can only be added to a definition once. A property cannot be used in a product definition as both a property and a variant property.

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