TipcMsgGetReadOnly

Name

TipcMsgGetReadOnly — get read-only property of message

Synopsis

T_BOOL TipcMsgGetReadOnly(msg, read_only_return) 
T_IPC_MSG msg; 
T_BOOL *read_only_return; 

Arguments

msg — message to get read-only property from

read_only_return — storage for read-only property

Return Values

TRUE if the read-only property was successfully retrieved from the message, FALSE otherwise.

Diagnostics

If TipcMsgGetReadOnly fails, it returns FALSE and sets the global SmartSockets error number to one of:

Description

TipcMsgGetReadOnly gets the read-only property of a message. A message is marked read only if the message is embedded as a field in another message.

Caution

If TipcMsgGetReadOnly returns FALSE, it does not store a value in read_only_return.

See Also

TipcMsgClone

Examples

This example prints the read-only property of a message:

void print_read_only(msg) 
T_IPC_MSG msg; 
{ 
  T_BOOL read_only; 
 
  if (!TipcMsgGetReadOnly(msg, &read_only)) { 
    return;  /* error */ 
  }  
  TutOut("The message is %smarked read-only.\n", 
          read_only ? "" : "not "); 
} /* print_read_only */