IProductCatalog3::CreateProduct Method [C++]

Use this method to create a new product within the catalog according to the specified parameters. This method cannot be used with virtual catalogs.

Definition

[C++]

HRESULT IProductCatalog3::CreateProduct(BSTRstrDefinitionName,
 VARIANTvarProductID,
 CURRENCYcyListPrice,
 VARIANTstrParentCategoryName,
 IProduct3**ppProduct);

[Visual Basic]

Function CreateProduct(strDefinitionName As String,
 varProductID As Variant,
 cyListPrice As Currency,
 Optional strParentCategoryName As Variant) As Product

Parameters

• strDefinitionName[C++]
  [in] A BSTR that contains the name of the product definition for the product.
• strDefinitionName[Visual Basic]
  A String that contains the name of the product definition for the product.
• varProductID[C++]
  [in] A VARIANT that contains the unique product ID for the product to be created. The data type must match the property used to uniquely identify products in this catalog.
• varProductID[Visual Basic]
  A Variant that contains the unique product ID for the product to be created. The data type must match the property used to uniquely identify products in this catalog.
• cyListPrice[C++]
  [in] A CURRENCY object that contains the list price of the product to be created.
• cyListPrice[Visual Basic]
  A Currency object that contains the list price of the product to be created.
• strParentCategoryName[C++]
  [in, optional] A VARIANT that contains the name of the category to be designated as the parent category of the product to be created.
• strParentCategoryName[Visual Basic]
  A Variant that contains the name of the category to be designated as the parent category of the product to be created.
• ppProduct[C++]
  [out, retval] A pointer to a Product object used to return the properties of the newly created product.

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 the Product object that was created.

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

A product family is a product that has variants.

The properties of the definition on which a new product is based will determine whether the product being created is a single product or a product family. If the definition used to create the product has variant properties, the newly created product will be a product family.

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

[Visual Basic]

Example

SET oMyNewProduct = myProductCatalog.CreateProduct("BasicProduct", "SKU3004", cyListPrice, "Apparel")

See Also

[C++]ProductCatalog Object

[Visual Basic]ProductCatalog Object

[C++]IProductCatalog3::DeleteProduct

[Visual Basic]ProductCatalog.DeleteProduct

[C++]IProductCatalog3::GetProduct

[Visual Basic]ProductCatalog.GetProduct

Copyright © 2005 Microsoft Corporation.
All rights reserved.