C++ Syntax

bool

MKI_ProfileReadString(

const LPCWSTR f_pszValueName,

LPSTR f_pValue,

const size_t f_unMaxSize );

template <size_t f_unSize> __forceinline bool

MKI_ProfileReadString(

const LPCWSTR f_pszValueName,

char (&f_rDestin)[f_unSize] );

bool

MKI_ProfileReadString(

const LPCWSTR f_pszValueName,

LPWSTR f_pValue,

const size_t f_unMaxSize );

template <size_t f_unSize> __forceinline bool

MKI_ProfileReadString(

const LPCWSTR f_pszValueName,

wchar_t (&f_rDestin)[f_unSize] );

Reads a string value 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 Changed in Version 2019.1

[LPSTR] Address of an Ansi buffer or [LPWSTR] Address of a UTF-16 buffer that is to receive the value if successful.

MaxSize Changed in Version 2019.1

[const size_t] Size of the buffer in characters.

Return Value

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