RtvdbSetVariableDisplayName

RtvdbSetVariableDisplayName sets the variable display name.

Syntax

Copy

DWORD RtvdbSetVariableDisplayName(
  [in]    RTVDB_VARIABLE Variable,
  [in]    const wchar_t* pDisplayName
);

Parameters

[in] Variable

A handle of the variable to associate the display name. To retrieve the corresponding handle, use RtvdbOpenVariable or RtvdbCreateVariable.

[in] pDisplayName

A pointer to the variable display name. The maximum name length is 63 characters, as defined by RTVDB_MAX_NAME_LENGTH in the header file.

Return Values

Error code	Meaning
ERROR_SUCCESS	The function succeeded.
ERROR_INVALID_PARAMETER	One of the following conditions occurred: Parameter Variable or pDisplayName is NULL. The value of parameter pDisplayName exceeds 63 characters in length.
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)