_OrderGroup::GetOrderFormValue Method [C++]

Use this method to get an attribute from an OrderForm, based on a specified key.

Definition

[C++]

HRESULT _OrderGroup::GetOrderFormValue(BSTRstrKey,
  VARIANTstrOrderFormName,
  VARIANT*pvtRetVal);

[Visual Basic]

Function GetOrderFormValue(strKey As String,
  Optional strOrderFormName As Variant) As Variant

Parameters

strKey[C++]
[in] A BSTR that contains the key that specifies the attribute to get.
strKey[Visual Basic]
A String that contains the key that specifies the attribute to get.
strOrderFormName[C++]
[in, optional] A VARIANT that specifies the OrderForm name.
strOrderFormName[Visual Basic]
A Variant that specifies the OrderForm name.
pvtRetVal[C++]
[out, retval] A pointer to a VARIANT used to return the attribute.

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 a Variant that contains the attribute.

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

Remarks

[C++] 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.

[Visual Basic]

Example

' oOrderGroup is a Commerce.OrderGroup object
vResult is a Variant

vResult = oOrderGroup.GetOrderFormValue(handling_total, _
"testOrderFormName")

Share via