C++ Syntax

bool

MKI_ProfileReadData(

const LPCWSTR f_pszValueName,

void* f_pValue,

const size_t f_unMaxSize );

Reads binary data from a previously opened key in the configuration file. Cannot be applied to a collection item.

This function is only provided for backward compatibility, i.e. for reading old configuration data. There is no longer a method to store binary data into the configuration!

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

[void*] Address of a buffer that is to receive the data if successful.

MaxSize

[const size_t] Size of the buffer in bytes. Valid range: 0 <= Size <= MKI_LENGTH_BINARY.

Return Value

Returns true if successful, false if not (e.g. if the buffer pointed to by Value is too small). The content of Value will only be altered if true is returned.