TipcMsgFileCreateFromFile

Name

TipcMsgFileCreateFromFile — create a message file from an existing file

Synopsis

T_IPC_MSG_FILE TipcMsgFileCreateFromFile(file, create_mode) 
FILE *file; 
T_IPC_MSG_FILE_CREATE_MODE create_mode;

Arguments

file — existing file to use for message file

create_mode — how to create the file

Return Values

A new message file if successful, NULL otherwise.

Diagnostics

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

T_ERR_NULL_PTR — file was null

T_ERR_VAL_INVALID — create_mode was not a valid T_IPC_MSG_FILE_CREATE_MODE create mode

T_ERR_C — a C error has occurred. Call the function TutErrNumGetC to obtain the related C-specific error value.

T_ERR_MSG_CORRUPT — the message file is not in the proper format

Description

TipcMsgFileCreateFromFile creates a new message file from an existing file. TipcMsgFileCreateFromFile can be used in those cases where a C stdio file is available, but not a file name (stdin, stdout, and stderr, for example). TipcMsgFileCreateFromFile can only be used with text format message files. See TipcMsgFileCreate for more information on text format versus binary format.

If create_mode is:

T_IPC_MSG_FILE_CREATE_READ, then the message file is created for reading, and TipcMsgFileRead can be used to read messages from the message file.

T_IPC_MSG_FILE_CREATE_WRITE, then the message file is created for writing, and TipcMsgFileWrite can be used to write messages to the message file.

T_IPC_MSG_FILE_CREATE_APPEND, then the message file is created for appending, and TipcMsgFileWrite can be used to append messages to the message file.

Caution

None

Examples

This example creates a message file for writing from the file stdout with TipcMsgFileCreateFromFile:

T_IPC_MSG_FILE msg_file; 
 
msg_file = TipcMsgFileCreateFromFile(stdout, 
T_IPC_MSG_FILE_CREATE_WRITE); 
if (msg_file == NULL) { 
  return;  /* error */ 
}