_OrderGroup::SaveAsTemplate

Ee811031.c++_off(en-US,CS.10).gifEe811031.vb_on(en-US,CS.10).gif

Use this method to save the OrderGroup to the database with a template status.

Definition

HRESULT _OrderGroup::SaveAsTemplate(VARIANTstrTemplateName,VARIANT*pvtRetVal);

Parameters

strTemplateName

[in, optional] A VARIANT that specifies the template name.

pvtRetVal

[out, retval] A pointer to a VARIANT used to return the OrderGroupID of the template.

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.

This method updates the OrderGroup template name field if the strTemplateName parameter is supplied.

If you originally loaded the OrderGroup from another state (ie a basket) and call SaveAsTemplate method, the original OrderGroup remains on disk unchanged.

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

See Also

OrderGroup Object

_OrderGroup::SaveAsBasket

_OrderGroup::SaveAsOrder


All rights reserved.