C++ Syntax

bool

MKI_ProfileReadTextFrame(

const LPCWSTR f_pszValueName,

MKI_TEXTFRAME_REF f_rValue );

Reads a frame text parameter set from a previously opened key in the configuration file or a collection item.

Parameters

ValueName Changed in Version 2019.1

[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_TEXTFRAME_REF] Address of a buffer that is to receive the frame text parameter set if successful. Will be ignored if set to nullptr.

Return Value

Returns true if successful, false if not. The content of Value will only be altered if true is returned.