Technical Reference > CtAPI Functions > Function Reference > ctListWrite

ctListWrite

Writes to a single tag on the list.

Syntax

ctListWrite(hTag, sValue, pctOverlapped)

hTag

Type: HANDLE
Input/output: Input
Description: The handle to the tag, as returned from ctListAdd().

sValue

Type: LPCSTR
Input/output: Input
Description: The value to write to the tag as a string. The value will be converted and scaled into the correct format to write to the tag.

pctOverlapped

Type: CTOVERLAPPED*
Input/output: Input
Description: CTOVERLAPPED structure. This structure is used to control the overlapped notification. Set to NULL if you want a synchronous function call.

Return Value

If the function succeeds, the return value is TRUE. If the function does not succeed, the return value is FALSE. To get extended error information, call GetLastError().

Related Functions

ctOpen, ctListNew, ctListFree, ctListAdd, ctListDelete, ctListRead, ctListData, ctListItem

Example

HANDLE	 hTagOne;
HANDLE hList;
hList = ctListNew(hCTAPI, 0);
hTagOne = ctListAdd(hList, "TagOne");
ctListWrite(hTagOne, "1.23", NULL); // write to TagOne