TipcMsgSetNameCurrent

Name

TipcMsgSetNameCurrent — sets the name of the current field

Synopsis

T_BOOL TipcMsgSetNameCurrent(msg, name) 
T_IPC_MSG msg; 
T_STR name; 

Arguments

msg — message containing field whose name is to be set

name — name of the field

Return Values

TRUE if the set was successful, FALSE otherwise.

Diagnostics

If TipcMsgSetNameCurrent fails, it returns FALSE and sets the global SmartSockets error number to:

Description

TipcMsgSetNameCurrent sets the name of the current field (the field that would be returned by a TipcMsgNext* function). If the current field has a name, it is overridden. If another field in the message already uses this name, this function fails.

Examples

This example sets the name of the current field:

T_BOOL status; 
 
status = TipcMsgSetNameCurrent(msg, "foo"); 
if (status == FALSE) { 
  return;  /* error */ 
}