UID_VariableGetName

Definition

Delphi

function UID_VariableGetName(DlgHandle: Cardinal; variableId: Cardinal; resultText: PWideChar; resultTextSize: Cardinal; reply: PCardinal): Boolean;

C/C++

bool UID UID_VariableGetName(unsigned int DialogHandle, unsigned int VariableId, wchar_t * resultText, unsigned int resultTextSize, unsigned int* repl);

ActiveX

HRESULT _stdcall UID_VariableGetName([in] unsigned long DialogHandle, [in] unsigned long VariableId, [out] BSTR* VariableName, [out, retval] VARIANT_BOOL* Result);

Description

Get a string name for dialog variable with id defined in VariableId.

Arguments

DialogHandle

Unused.

VariableId

Integer value used for variable identification.

resultText

Pointer to wide character buffer used to return variable name.

resultTextSize

The size of a buffer pointed by resultText, in characters.

reply

This returns the reusultText buffer's length, required to accommodate all the characters of returned variable name not including zero terminator,

So the function can be called twice: first time with resultText set to NULL pointer, then allocate a buffer resultText to handle of reply + 1 wide characters,and call it a second time.

Return value

True on success, false otherwise.