_SiteConfig::get_Fields Property
Note
This object is obsolete. Use SiteConfigFreeThreaded instead.
The Fields property is a read/write Fields object. The Fields object contents include recordsets that hold the configuration settings of resources. A Fields object is an ADO disconnected recordset.
HRESULT _SiteConfig::get_Fields(
Fields** Fields
);
Property Fields As Object
Parameters
Fields
[C++][out] The address into which this method writes the pointer to the Fields object used to return resource configuration information.
Return Value
[C++]
This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.
[Visual Basic]
None.
Error Values
[C++]
This property 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 property 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.
All ADO, SQL Server, and ODBC errors will also be returned by this method.
Remarks
The Fields parameter contains valid data only if the method completes successfully.
You update the data in the Fields object to change your configuration information. You then call SaveConfig to commit those changes back to the database.
Child recordsets, containing the resource properties for the child resources, are inserted directly into the fields collection of the parent in the database.
The Commerce Server 2009 version is different from the Commerce Server 2002 version in that the Fields property would be a recordset whose columns were of type adChapter. The new behavior is that the column type is adIDispatch and refers to the child recordset.
f_ResourceFlags
The f_ResourceFlags field value indicates a resource's type. In your code, you can apply the following bitmasks against the f_ResourceFlags field value to determine the type of a given resource.
Bitmask |
Description |
|---|---|
0x00000001 |
Set when this row is a reference to a global resource. |
0x00000002 |
Set when this resource can be displayed in MMC. |
0x00000004 |
Set when this resource has its own snap-in. The ProgID of the snap-in extension must be in the s_ProgIDSnapIn field when this bit is set. |
0x00000008 |
Set when this resource is an application in a site. Not used externally. |
0x00000010 |
Set when this resource is a physical resource. Affects delete functionality. Defaults to the first global resource like it. During custom unpacking, requires user to select existing global resource. Used in combination with IS_REFTOGROUPRES. |
0x00000020 |
Set for resources that are always to be packaged by Commerce Server Site Packager. |
0x00000040 |
Set for Addresses and AddressItems, which may not be related to Commerce Server. |
0x00000080 |
Set for resources that use a non-standard snap-in extension (currently only used by the Data Warehouse resource). The use of this flag is not recommended because of the special programming considerations that are required. |
0x00000100 |
Set for resources that are never to be packaged by Commerce Server Site Packager. Set this bit when you do not want to transfer resources from one computer to another. |
0x00000200 |
Set for legacy Commerce Server 2002 Business Desk applications. |
0x00000400 |
Set for Commerce Server Web services. |
0x00000800 |
Set for Orders Web service. |
0x00001000 |
Set for Catalog Web service. |
0x00002000 |
Set for Marketing Web service. |
0x00004000 |
Set for Profiles Web service. |
The following are example f_ResourceFlags field values for common resource types.
Resource type |
f_ResourceFlags value |
|---|---|
Runtime site |
10 |
Business Desk application |
522 |
Web service |
1034 |