ISSOConfigStore::GetConfigInfo

Article
02/02/2021

The GetConfigInfo method gets the configuration information from the config store.

Syntax

  
HRESULT GetConfigInfo(  
BSTR bstrApplication,  
BSTR bstrIdentifier,  
LONG lFlags,  
IPropertyBag* ppbConfigInfo  
);

  
GetConfigInfo(  
bstrApplication As BSTR,  
bstrIdentifier As BSTR,  
lFlags As LONG,  
ppbConfigInfo As IPropertyBag  
)

Parameters

bstrApplication
[in] String containing the Single Sign-On (SSO) server. This property is optional.

bstrApplication
[in] String containing the SSO server. This property is optional.

bstrIdentifier
[in] String containing the identifier for the config info. This string is typically a GUID string.

lFlags
[in] Long integer containing the flags.

ppbConfigInfo
[in] Pointer to an empty property bag that is populated with the config info as name/value pairs.

Return Value

This method does not return a value.

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The config info was successfully returned from the config store.
E_ACCESSDENIED	Access denied.
E_INVALIDARG	Invalid argument.

Remarks

This method can be executed either in admin or run-time (lookup) mode. The caller specifies SSO_FLAG_LOOKUP if the run-time (lookup) mode is required. The default mode is admin mode.

In admin mode, masked properties are not returned. Instead, the property is missing. Unmasked properties are returned. Admin mode can specify any SSO server, not just the local computer.

In run-time mode, all properties, including masked properties, are returned. Because run-time mode only uses the SSO server on the current computer, the bstrSSOServer parameter will be ignored.

If the bstrSSOServer parameter is NULL, the SSO server location is obtained from the registry. (This applies to admin mode only. Run-time mode always uses the local computer.) If the server location is not available in the registry, the local computer is used.

To get the config info, this method is provided with an empty property bag that is populated with the properties. This allows the BizTalk Server 2006 implementation of the property bag to be used, which can handle the type conversion from BSTRs to the actual variant types based on a format convention specific to BizTalk Server 2006. The property values will be XML tags for Host Integration Server.

Example Code

  
ConfigStore  
bstrApplication  
bstrIdentifier  
lFlags  
ppbConfigInfo