Ets_Obj_Confirm_Error_Log()
Abstract
Writes an error message to the message log.
Syntax
Ets_Obj_Confirm_Error_Log (obj_hndl, err_str)
| Argument | Type | Description |
|---|---|---|
obj_hndl |
EtsT_Obj_Handle |
Handle to the object to which the error message applies. |
err_str |
char * |
Text of the error message to be added to the log. |
Return Type
void
No return value.
Header
ets_api_obj_dbox.h
Details
This function is intended to be used mainly with the Edit Objects Using Template operation (described in “Using the Attribute Template Method“ on page 410). When active attribute confirm handlers are used with the attributes being edited, a mass editing using copy and paste might result in many attribute errors. Typically (in a single object attribute dialog), an error message is displayed to tell the user about the error. However, if there are many errors, it would be better to put the errors in a log for later viewing. In such cases, this function can replace calls to Ets_Msg_Warning() (or similar functions) in the active attribute confirm handlers.
Currently, this function has an effect only for dialog boxes with a list attribute table. For other dialog boxes, this function will simply call Ets_Msg_Warning().