Ets_Nt_Link_Consistency_Error_Msg_Set()
Abstract
Sets the error message to be displayed by an inconsistent ETS link object.
Syntax
Ets_Nt_Link_Consistency_Error_Msg_Set (link_hndl, msg_tlist_ptr)
| Argument | Type | Description |
|---|---|---|
link_hndl |
EtsT_Obj_Handle |
Handle of the object of interest. |
msg_tlist_ptr |
PrgT_List* |
List of strings to be displayed. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if the object is a link and the list of strings is set on the object. EtsC_Compcode_Failure otherwise.
Header
ets_api_nt.h
Details
When the link is an inconsistent state (as set using Ets_Nt_LInk_Consistency_Set()), double-clicking on the link will display whatever message has been associated using this function. Assigning a message to the link destroys any previously assigned message.
The list of strings passed in is copied internally.