MKI_ProfileWriteNamedXProperty (Settings) New in Version 2020.0

C++ Syntax

bool

MKI_ProfileWriteNamedXProperty(

 const LPCWSTR f_pszValueName,

 MKI_CONST_XPROPERTY_REF f_rValue,

 __int32 f_nCopyFlag );

Writes an extended property set to a previously opened item in the configuration file or a collection item. The indexes of all elements will be used to determine the element names to write. (Use the other version if the element names shall be written directly.)

bool

MKI_ProfileWriteNamedXProperty(

 const LPCWSTR f_pszValueName,

 MKI_CONST_NAMED_XPROPERTY_REF f_rValue );

Writes an extended property set to a previously opened item in the configuration file or a collection item. The names of all elements as stored will be written directly, the indexes will be ignored. (Use the other version if the element indexes shall be used.)

Parameters

ValueName

[const LPCWSTR] Name of the value inside the plug-in's key, up to 63 characters. This value name must be unique throughout all values stored by the plug-in. Use a point as separator for nested value names and brackets for arrays (e.g. "UserData[5].Name").

Value

[MKI_CONST_XPROPERTY_REF] Address of the extended property set to be stored.

[MKI_CONST_NAMED_XPROPERTY_REF] Address of a named extended property of which the extended property set and the copy flag (if non-zero) shall be stored.

CopyFlag

[__int32] Indicator which elements of the extended property set are "active", i.e. shall be restored later. A bit-wise OR combination of one or more values (see MKI_USE_*). Set to zero if unused.

Return Value

Returns true if successful, false if not.