TipcMsgFileDestroy

Name

TipcMsgFileDestroy — destroy a T_IPC_MSG_FILE

Synopsis

T_BOOL TipcMsgFileDestroy(msg_file) 
T_IPC_MSG_FILE msg_file; 

Arguments

msg_file — T_IPC_MSG_FILE to destroy

Return Values

TRUE if the T_IPC_MSG_FILE was successfully destroyed, FALSE otherwise.

Diagnostics

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

Description

TipcMsgFileDestroy destroys a T_IPC_MSG_FILE. All memory for the T_IPC_MSG_FILE is freed. If the message file was created with TipcMsgFileCreateFromFile, then the file is left open, otherwise the file is closed. The file on disk is not removed.

Caution

TipcMsgFileDestroy does not remove the message file from disk.

See Also

TipcMsgFileCreate, TipcMsgFileRead, TipcMsgFileWrite

Examples

This example destroys a T_IPC_MSG_FILE with TipcMsgFileDestroy:

if (!TipcMsgFileDestroy(msg_file)) { 
  return;  /* error */ 
}