_OrderGroup::GetOrderFormValue
.gif "Ee799746.c++_off(en-US,CS.10).gif")
.gif "Ee799746.vb_on(en-US,CS.10).gif")
Use this method to get an attribute from an OrderForm, based on a specified key.
Definition
HRESULT _OrderGroup::GetOrderFormValue(BSTRstrKey,VARIANTstrOrderFormName,VARIANT*pvtRetVal);
Parameters
strKey
[in] A BSTR that contains the key that specifies the attribute to get.
strOrderFormName
[in, optional] A VARIANT that specifies the OrderForm name.
pvtRetVal
[out, retval] A pointer to a VARIANT used to return the attribute.
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
The pvtRetVal parameter points to valid data only if the method completed successfully.
If the strOrderformName parameter is not supplied, the strOrderFormName parameter defaults to "default".
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.