Core Objects
The core objects perform a variety of functions including writing error and warning events to the event log, retrieving Web site properties, storing name/value pairs, generating globally unique identifiers (GUIDs), retrieving the contents of server-side files, and securing the site.
The Core Objects Programming Concepts topic describes the major issues relating to the use of the general purpose objects.
Objects
| Visual Basic Reference | C++ Invocation | Description |
|---|---|---|
| AdminEventLog | AdminEventLog | Writes error, informational, warning, and success messages to the event log. |
| AdminFiles | AdminFiles | Provides read-only access to server-side binary and text files. |
| AppFrameWork | AppFrameWork | Provides formatting and validation methods that simplify forms processing in Active Server Pages (ASP). |
| AuthManager | AuthManager | Providesa secure, standardized, and extensible way to manage authentication of users. |
| BizDeskSecurity | BizDeskSecurity | Allows specific Commerce Server Business Desk modules to be hidden from particular users. |
| DataFunctions | DataFunctions | Provides methods to perform locale-based data type handling and value range checking. |
| DBStorage | DBStorage | Provides methods for mapping Dictionary and SimpleList objects to and from a database, primarily for the storage of receipt and order information. |
| Dictionary | Dictionary | Supports the creation, storage, and retrieval of name/value pairs in memory. |
| DictionaryXMLTransforms | DictionaryXMLTransforms | Transforms data in a Dictionary object into Extensible Markup Language (XML), and XML data into a Dictionary object. |
| EuroDisplay | EuroDisplay | Converts and formats currency amounts for use where multiple currencies must be displayed. |
| GenID | GenID | Provides methods to generate globally unique identifiers (GUID), and to create and maintain multiple, global sequential counters which are persisted in a database. |
| MessageManager | MessageManager | Stores text strings in multiple languages. One usage involves the Order Processing pipeline (OPP) components describing error conditions generated during order form processing. |
| SimpleList | SimpleList | Allows creation of an array of Variants that supports enumeration. |
Examples
| Example | Description |
|---|---|
| Code to Write an Error Event to the Commerce Server Event Log | Describes how to write an error event to the Commerce Server 2002 event log. |
| Code to Read and Display the Contents of a Server-Side File | Describes how to read the contents of a server-side file and write those contents to the browser. |
| Code to Dump Dictionary Values | Describes how to dump the contents of a Dictionary object. |
| Code to Create and Manipulate a SimpleList | Describes how to create and work with the SimpleList object. |
| Code to Implement Custom Cache Components | Describes how to implement custom cache components. |
| Code to Manipulate an LRUCache Object | Describes how to manipulate an LRUCache object |
| Code to Generate a GUID | Describes how to generate a globally unique identifier (GUID). |
| Code to Control Display of a Business Desk Module | Describes how to control whether a specified Business Desk module is displayed to the current user. |
| Code to Create and Initialize AuthManager | Describes how to instantiate and initialize the AuthManager object. |
| Code to Manipulate Site Configuration Properties | Describes how to change CS Authentication resource properties. |
| Code to Retrieve Login Credentials | Describes how to retrieve the user ID and password submitted on an HTML form using either the Get method or the Post method. |
| Code to Set a New MSCSProfile Ticket | Describes how to create an MSCSProfile ticket. |
| Code to Retrieve a Profile and Set an MSCSAuth Ticket | Describes how to retrieve a profile using the Commerce Server Profiles resource, and set an MSCSAuth ticket. |
| Code to Retrieve Login Credentials Using the Post Method and Set an MSCSAuth Ticket | Describes how to retrieve the user ID and password submitted on a HTML form using the Post method, get the profile corresponding to the user ID using the Commerce Server Profiles resource, set the user ID in an MSCSAuth ticket, and redirect the user to the originally requested URL. |
| Code to Set a Custom Property on a Ticket | Describes how to create a globally unique identifier (GUID) string and place it on an MSCSAuth ticket as a guid property. |
| Code to Generate an Encoded URL String | Describes how to generate an encoded URL string from a file name. |
| Code to Apply Data Type Conversion and Range Checking | Describes how to perform locale-based data type conversion and range validation. |
| Code to Manipulate and Display Euro Values | Describes how to use the EuroDisplay object to convert currency amounts. |
| Code to Convert Between Numbers and Strings | Describes how to use the conversion functions of the DataFunctions object. |
| Code to Display Locale-Specific Strings | Describes how to use locale-based conversion functions of the DataFunctions object. |
| Code to Manage Common Error Messages to Users | Describes how to add languages and messages to the MessageManager object, and how to write messages to a Web browser. |
Copyright © 2005 Microsoft Corporation.
All rights reserved.