IAppCfg::GetOptionsDirectory Method

For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.

Use this method to retrieve a Dictionary object that contains the site configuration information.

HRESULT IAppCfg::GetOptionsDictionary(
  BSTR bstrUserID,
  IDictionary** ppdispOptionsDictionary
);

Function GetOptionsDictionary(  bstrUserIDAs String) As Object

Parameters

• bstrUserID
  [C++]

  [in] A BSTR that contains an empty string ("").

  [Visual Basic]

  A String that contains an empty string ("").

• ppdispOptionsDictionary
  [C++]

  [out, retval] The address of a pointer used to return an IDictionary interface pointer. The associated Dictionary object contains the site configuration information. See the Remarks section for a list of some dictionary keys.

Return Value

[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 reference to a Dictionary object. This object contains an alphabetical list of country/region names.

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 ppdispOptionsDictionary parameter contains valid data only if the method returns successfully.

Some options dictionary keys, such as i_AuctionOptions, are reserved for future use. The following table lists the names of the keys in the Dictionary object returned by this method that are mapped in the Microsoft Management Console (MMC).

Programmatic Name	MMC Default Configuration Mapping
i_AddItemRedirectOptions	Add item redirect options
i_AddressBookOptions	Address book options
f_AltCurrencyConversionRate	Currency: Alternate currency conversion rate
i_AltCurrencyLocale	Currency: Alternate currency locale
i_AltCurrencyOptions	Currency: Alternate currency options
i_BaseCurrencyLocale	Currency: Base currency locale
i_BillingOptions	Payment options: Billing options
i_BizTalkOptions	BizTalk options
i_CookiePathCorrectionOptions	Cookie path correction options
i_CurrencyDisplayOrderOptions	Currency: Currency display order options
i_DelegatedAdminOptions	Delegated admin options
i_FormLoginOptions	Form login options
i_FormLoginTimeOut	Authorization Manager authorization ticket timeout
i_HostNameCorrectionOptions	Host name correction options
i_PaymentOptions	Payment options
i_SitePrivacyOptions	Site privacy options
i_SiteRegistrationOptions	Site registration options
i_SiteTicketOptions	Site ticket options
s_AltCurrencySymbol	Currency: Alternate currency symbol
s_BaseCurrencySymbol	Currency: Base currency symbol
s_BizTalkCatalogDocType	BizTalk catalog document type
s_BizTalkConnString	BizTalk connection string
s_BizTalkOrderDocType	BizTalk purchase order document type
s_BizTalkSourceQualifierID	BizTalk source organization qualifier
s_BizTalkSourceQualifierValue	BizTalk organization qualifier value
s_BizTalkSubmittypeQueue	BizTalk submit type
s_PageEncodingCharset	Page encoding character set
s_SMTPServerName	SMTP server name
s_WeightMeasure	Unit of measure for weight

The following table lists keys in the Dictionary object returned by this method that are not mapped in the MMC.

Programmatic Name	Value or Description
i_IsFullTextSearchInstalled	Indicates whether SQL Server has full text search enabled
s_BizDataStoreConnectionString	Profile Service: s_BizDataStoreConnectionString
s_CampaignsConnectionString	Campaigns: connstr_db_Campaigns
s_CatalogConnectionString	Product Catalog: connstr_db_Catalog
s_CommerceProviderConnectionString	Profile Service: s_CommerceProviderConnectionString
s_NonSecureHostname	This value is set in the Global.asa file to the non-secure host name of the application.
s_ProfileServiceConnectionString	Profile Service: s_ProfileServiceConnectionString
s_SecureHostname	This value is set in the Global.asa file to the secure host name of the application.
s_SiteName	Name of the site
s_TransactionConfigConnectionString	Transaction Configuration: connstr_db_TransactionConfig
s_TransactionsConnectionString	Transactions: connstr_db_Transactions

Example

' oAppConfig is a AppConfig object.
' dDictConfig is a Dictionary object.
Set dictConfig = oAppConfig.GetOptionsDictionary("") 
For Each sKey In dictConfig 
    Response.Write sKey & "=" & dictConfig.Value(sKey)
Next

See Also

Other Resources

AppConfig Object