JAM_ReadMsgHeader(3) JAM subroutine library JAM_ReadMsgHeader(3) NAME JAM_ReadMsgHeader - Read a message's header and its subfields SYNOPSIS #include <jamlib/jam.h> int JAM_ReadMsgHeader(s_JamBase* Base_PS, ulong MsgNo_I, s_JamMsgHeader* Header_PS, s_JamSubPacket** Subfields_PPS); DESCRIPTION Reads a message header and (optionally) the message header subfields. Arguments Base_PS The message base to use MsgNo_I The message number, i.e. the absolute position of the message in the message base. Message 0 is the first message. Header_PS A pointer to a message header structure where the message header will be stored. Subfields_PPS A pointer to a subpacket pointer, where the subfield packet handle will be stored. If this parameter is NULL, no subfields are read. RETURN VALUE 0 if successful JAM_IO_ERROR if an I/O error occured. See JAM_Errno(3) JAM_NO_MEMORY if a memory allocation failed JAM_NO_MESSAGE if message has been removed JAM_CORRUPT_MSG if message subfields are corrupted EXAMPLES s_JamMsgHeader Header_S; s_JamSubPacket* SubPack_PS int Result_I; Result_I = JAM_ReadMsgHeader(0, &Header_S, &SubPack_PS); if (Result_I) printf("JAM_ReadMsgHeader 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 Johan Billing <billing@df.lth.se>. SEE ALSO jamlib(3), JAM_AddMessage(3), JAM_AddEmptyMessage(3), JAM_ChangeMsg- Header(3), JAM_Errno(3) 2002-11-07 JAM_ReadMsgHeader(3)
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | EXAMPLES | AUTHOR | SEE ALSO
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=JAM_ReadMsgHeader&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>