ICacheManager::get_LoaderConfig, putref_LoaderConfig Property [C++]

Article
11/12/2009

The LoaderConfig property is a read/write reference to a Dictionary object that contains configuration information for the Loader component.

Definition

[C++]

Get method:

HRESULT ICacheManager::get_LoaderConfig(BSTRbstrName,
 IDispatch**LoaderConfig);

Put method:

HRESULT ICacheManager::putref_LoaderConfig(BSTRbstrName,
 IDispatch*LoaderConfig);

[Visual Basic]

Property LoaderConfig(bstrName As String) As IDispatch

Parameters

bstrName[C++]
[in] A BSTR that contains the name of a data cache for which Loader component configuration information is being provided or retrieved.
bstrName[Visual Basic]
A String that contains the name of a data cache for which Loader component configuration information is being provided or retrieved.
LoaderConfig[C++]
[in] When putting the property, a pointer to the IDispatch interface of the Dictionary object that contains the Loader component configuration information.
[out,retval] When getting the property, the address of a pointer used to return the IDispatch interface of the Dictionary object that contains the configuration information.

[C++]

Return Values

This method returns an HRESULT indicating whether they completed successfully. See the Error Values section for more details.

Error Values

[C++] These methods return 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.

Remarks

This property, a Dictionary object containing configuration information for a particular Loader component, will be passed to that Loader component when it is created to load the associated data cache. When you set this property, the dictionary is shallow cloned and then the CacheManager object stores the clone of the dictionary. This is as opposed to simply storing a reference to the dictionary. Shallow clone means that scalars in the dictionary are copied by value, but other objects in the dictionary are copied by reference. The Loader component needs to implement the IPipelineComponentAdmin interface in order to read the configuration values from the dictionary, and in particular, the SetConfigData method of that interface. The Dictionary object identified by this property is passed to the newly created Loader component using the SetConfigData method.