TipcMsgGetCompression

Name

TipcMsgGetCompression — get the compression status of a message

Synopsis

T_BOOL TipcMsgGetCompression(msg, compress_return) 
T_IPC_MSG msg; 
T_BOOL *compress_return; 

Arguments

msg — message to get compression status from

compress_return — storage for message compression status

Return Values

TRUE if the compression status was successfully retrieved from the message, FALSE otherwise.

Diagnostics

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

Description

TipcMsgGetCompression gets the compression status of a message, or whether or not compression is enabled. When a message is created, its compression status is initialized to the message type's compression status. Use TipcMsgSetCompression to change the default compression status of a message.

Caution

If TipcMsgGetCompression returns FALSE, it does not store a value in compress_return.

See Also

TipcMsgSetCompression, TipcMtGetCompression

Examples

This example gets the compression status of a message:

T_BOOL compress; 
 
if (!TipcMsgGetCompression(msg, &compress)) { 
  return;  /* error */ 
}