RtvdbGetVariableDisplayName gets the variable display name.
Syntax
DWORD RtvdbGetVariableDisplayName(
[in] RTVDB_VARIABLE Variable,
[in] wchar_t* pDisplayName
);Parameters
[in] Variable
A handle of the variable to read. To retrieve the corresponding handle, use RtvdbOpenVariable or RtvdbCreateVariable.
[in] pDisplayName
A pointer to the buffer of the variable display name. The buffer length must be 64 characters.
Return Values
| Error code | Meaning |
|---|---|
|
ERROR_SUCCESS |
The function succeeded. |
|
ERROR_INVALID_PARAMETER |
Parameter Variable or pDisplayName is NULL. |
|
ERROR_INVALID_HANDLE |
Parameter Variable does not point to a variable or points to a closed variable. |
|
ERROR_ABANDONED_WAIT_0 |
Failed to acquire the synchronization lock. |
|
ERROR_NOT_READY |
The calling process has not called RtvdbInitialize. |
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
wRTOS 1.1 SDK |
RtvdbApi.h |
RtvdbApi_W64.lib (Windows), RtvdbApi.lib (RTSS) |
See Also:
