MKI_VariableGetComment (Elements) New in Version 2023.2

C++ Syntax

bool

MKI_VariableGetComment(

 const LPCWSTR f_pszName,

 MKI_COMMENTSHORT& f_rData );

Copies the desired variable's comment into the buffer pointed to by Data, if defined.

Parameters

Name

[const LPCWSTR] Name of the variable. The maximum length of a variable's name is MKI_LENGTH_NAME_SHORT characters!

Data

[MKI_COMMENTSHORT&] Address of a buffer to retrieve the desired variable comment.

Return Value

Returns true if successful, false if not.