Ets_Ctl_Value_Str_Get()
Note: Requires OPNET Development Kit
Abstract
Gets the string value of a control.
Syntax
Ets_Ctl_Value_Str_Get (ctl_ptr, value_ptr, buflen)
| Argument | Type | Description |
|---|---|---|
ctl_ptr |
EtsT_Ctl * |
pointer to an ETS control |
value_ptr |
char * |
pointer to a buffer to receive the value of the control |
buflen |
int |
the size of the buffer |
Return Type
EtsT_Compcode
EtsC_Compcode_Failure if the control is not of string type; EtsC_Compcode_Success otherwise.
Header
ets_api_gui.h
Details
If the value type of the control is not "string", the function issues a recoverable error. Otherwise, it writes the value into the location specified by value_ptr. Only the first (buflen - 1) characters of the name are written into the buffer, to allow for the terminating NULL character. Controls that have string values include combo boxes, edit fields, labels, and pop-up menus.