gfdReadStatusFileHeader( )

Description | Example

Name:	int gfdReadStatusFileHeader (int fid, struct cp_status_header_s header)
Inputs:	int fid	The file handle returned by gfdOpenStatusFile.
Outputs:	struct cp_status_header_s header	Pointer to the data structure maintained in memory that holds the status table.
Returns:	GFD_SUCCESS	The status record was successfully read.
	GFDBAD_STATUS_FILE	The status file is corrupted.
	GFDNO_STATUS_FILE	The status file could not be found.
Includes:	gfdstatu.h
	gfdmsg.h
	gfdipc.h	gfdipc.h requires that the file gfdmsg.h be included first.

Description

The gfdReadStatusFileHeader( ) function reads version, size, and date information from a status file.

One field in the status-file header shows the number of fax channels active in the chassis. Also in the header file is a cp_status_header data-structure definition for a header of a status file. Table 41 lists the fields in a status-file header. A data structure for the status table is in GFDSTATU.H, which is the header file for status functions included in GDK. This structure follows:

struct cp_status_header_s {  
      short cp_status_version; /* version of status file */  
      short cp_header_size;   /* size of header (bytes) */  
      short cp_record_size;   /* allocated size for each card */  
      short cp_max_channel;   /* number of channels allocated */  
      time_t cp_last_update;  /* time of last update */  
};

Table 41. Fields in the Status-File Header

Data Type	Field Name	Description
int	cp_status_version	Version of the status file.
int	cp_header_size	Size of the header in bytes.
int	cp_record_size	Allocated size for each fax channel.
int	cp_max_channel	Number of fax channels active in the chassis.
time_t	cp_last_update	Time of last update.

Example

#include "gfdstatu.h"  
#include "gfdmsg.h"  
#include "gfdipc.h"  
struct cp_status_header_s header;  
/*Display header inforrmation*/  
gfdReadStatusFileHeader (status_fid, &header);  
printf ("Status file is version %d\n", header.cp_status_version);  
printf ("Status file reports %d active channels\n",   
        header.cp_max_channel);  
printf ("Status file last updated %s\n",   
        ctime(&header.cp_last_update));

Click here to contact Dialogic Customer Engineering