CacheManager.WriterConfig Property (PIA)

Article
11/12/2009

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

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Caching
…
Public Property WriterConfig(bstrName As String) As Object

[C#]

Get method:

using Microsoft.CommerceServer.Interop.Caching;
…
public object get_WriterConfig(stringbstrName);

Put method:

public void set_WriterConfig(stringbstrName,
 object ppdispConfig);

Parameters

[Visual Basic .NET]

bstrName
A String that contains the name of a data cache for which Writer component configuration information is being provided or retrieved.

[C#]

bstrName
A string that contains the name of a data cache for which Writer component configuration information is being provided or retrieved.
ppdispConfig
When setting the property, a Dictionary object that contains the Writer component configuration information.

Return Values

When getting, an object (typically a Dictionary) with the configuration.

Exceptions

This property may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

Remarks

This property, a Dictionary object containing configuration information for a particular Writer component, is passed to that Writer component when it is created to report results related to cache usage. 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 Writer 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 created Writer component using the SetConfigData method.

[C#] The get_WriterConfig and set_WriterConfig methods do not show up in IntelliSense.

Requirements

Namespace: Microsoft.CommerceServer.Interop.Caching

Platforms: Windows 2000, Windows Server 2003

Assembly: cachecomplib (in cachecomplib.dll)

Share via