_OrderGroup::PutOrderFormValue
.gif "Ee811627.c++_off(en-US,CS.10).gif")
.gif "Ee811627.vb_on(en-US,CS.10).gif")
Use this method to set an attribute on an OrderForm. If the strOrderFormName parameter is supplied, and the OrderForm does not exist in the OrderGroup, then a new OrderForm with the supplied name is created.
If strOrderFormName is not supplied, the parameter defaults to "default".
Definition
HRESULT _OrderGroup::PutOrderFormValue(BSTRstrKey,VARIANTvtValue,VARIANTstrOrderFormName);
Parameters
strKey
[in] A BSTR that specifies the key whose attribute will store the value specified by the vtValue parameter.
vtValue
[in] A VARIANT that specifies the value to store in the attribute of the key specified by the strKey parameter.
strOrderFormName
[in, optional] A VARIANT that specifies the OrderForm name.
Return Values
This method returns an HRESULT indicating whether or not it completed successfully. See the Error Values section for more details.
Error Values
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.
Remarks
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.