StringPreferences Object

This object provides access to Merge preferences that are represented by strings. Use the (default) Item property to get and set these preferences.

Properties

Itemread/writeIStringPreferences

Provides access to the specified preference string.

IDL [propget] HRESULT Item(
    [in] VARIANT index,
    [out, retval] BSTR* pValue)
[propput] HRESULT Item(
    [in] VARIANT index,
    [in] BSTR newValue)
.NET String get_Item(
    Object index)
void set_Item(
    Object index, String newValue)
VB6 Item(
    index As Variant) As String
  • index
    The index of the preference item of interest. The index can be either a numeric value from the ConfigString enumeration, or a string version of the value (for example, “csUnchangedFont”). You can use the latter from scripting languages that do not have access to the symbolic enumeration constants.

Methods

SetIStringPreferences

Sets the value of the specified preference item. This method is provided for use by scripting languages that are unable to use the Item property.

IDL HRESULT Set(
    [in] VARIANT index,
    [in] BSTR newValue)
.NET void Set(
    Object index,
    String newValue)
VB6 Set(
    index As Variant,
    newValue As String)
  • index
    The index of the preference item of interest. The index can be either a numeric value from the ConfigString enumeration, or a string version of the value (for example, “csUnchangedFont”). You can use the latter from scripting languages that do not have access to the symbolic enumeration constants.
  • newValue
    The new value of the preference item.