Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
JAM_ReadMBHeader(3)	    JAM	subroutine library	   JAM_ReadMBHeader(3)

NAME
       JAM_ReadMBHeader	- Read message base header

SYNOPSIS
       #include	<jamlib/jam.h>

       int JAM_ReadMBHeader(s_JamBase*	     Base_PS,
			    s_JamBaseHeader* Header_PS);

DESCRIPTION
       Reads the message base header from the start of the JAM header file.

   Arguments
       Base_PS
	      The message base to use

       Header_PS
	      A	 pointer to a base header structure where the base header will
	      be stored.

RETURN VALUE
       0      if successful

       JAM_IO_ERROR
	      if an I/O	error occured. See JAM_Errno(3)

       JAM_BAD_PARAM
	      if Base_PS or Header_PS is NULL

EXAMPLES
       s_JamBaseHeader BaseHeader_S;
       int	       Result_I;

       Result_I	= JAM_ReadMBHeader(Base_PS, &BaseHeader_S);
       if (Result_I)
	 printf("JAM_ReadMBHeader returned %d.\n", Result_I);

AUTHOR
       This manual page	was created by Sir Raorn <raorn@altlinux.ru>, based on
       original	JAMlib documentation by	Bjorn Stenberg <bjorn@haxx.nu> and Jo-
       han Billing <billing@df.lth.se>.

SEE ALSO
       jamlib(3), JAM_WriteMBHeader(3),	JAM_Errno(3)

				  2002-11-07		   JAM_ReadMBHeader(3)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | EXAMPLES | AUTHOR | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=JAM_ReadMBHeader&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help