IAppCfg::GetOptionsDictionary

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

Definition

HRESULT IAppCfg::GetOptionsDictionary(BSTRbstrUserID,IDictionary**ppdispOptionsDictionary);

Parameters

bstrUserID

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

ppdispOptionsDictionary

[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 Values

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

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

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).

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

See Also

AppConfig Object

All rights reserved.