OrderForm Object [C++]
The OrderForm object provides for the in-memory storage of user and purchase information. Commerce Server 2002 Enterprise Edition (EE) sites use the OrderForm object to store the items that a user has chosen to purchase, and to store receipt information that reflects the purchase history for a given user.
| ProgID: | Commerce.OrderForm (Externally creatable) |
| COM Class Name: | COrderForm |
| Type Library Name: | Microsoft Commerce 2002 Core Components Type Library |
| DLL Name: | MscsCore.dll |
| Threading Model: | Both |
[C++]
| COM Interface Name: | IOrderForm |
| Interface ID Constant: | IID_IOrderForm |
| Header File: | commerce.h, mspu_guids.h |
[C++]
In C++, use the IOrderForm interface to access the properties and methods of the OrderForm object.
Methods
[C++]
| Method | Description |
|---|---|
| AddItem | Adds the specified item to the items collection of the object. |
| ClearItems | Clears the items collection of the object. |
| ClearOrderForm | Clears the entire OrderForm object. |
[Visual Basic]
| Method | Description |
|---|---|
| AddItem | Adds the specified item to the items collection of the object. |
| ClearItems | Clears the items collection of the object. |
| ClearOrderForm | Clears the entire OrderForm object. |
Remarks
The OrderForm object is defined internally as a structured group of SimpleList and Dictionary objects, and includes the methods required to add items, clear items, and clear the entire OrderForm object itself.
The base of the OrderForm object is a Dictionary object, which contains information that describes the entire order. This includes user information, such as the shopper ID, name, and address, as well as order cost information, such as purchase subtotal, tax, shipping, and total.
The OrderForm object does not directly support storage of its data on disk. The DBStorage and OrderGroupManager objects enable persistent storage of OrderForm object data.
A number of the elements in the base Dictionary object of the OrderForm object include underscore (_) characters. The appearance of an underscore character in an element name indicates that these items are not saved to the OrderForm storage for the site. These elements are saved instead to the receipt storage of the site when the purchase is finalized.
See Also
[C++]OrderGroup Object
[C++]SimpleFindSearchInfo Object
[C++]SimpleFindResultInfo Object
[Visual Basic]Business Process Objects
[Visual Basic]OrderGroup Object
[Visual Basic]OrderGroupManager Object
[Visual Basic]SimpleFindSearchInfo Object
[Visual Basic]SimpleFindResultInfo Object
Copyright © 2005 Microsoft Corporation.
All rights reserved.