55 lines
1.2 KiB
Groff
55 lines
1.2 KiB
Groff
|
.\" $Id: JAM_DelSubPacket.3,v 1.1 2002/11/09 00:37:16 raorn Exp $
|
||
|
|
.\"
|
||
|
|
.TH JAM_DelSubPacket 3 2002-11-07 "" "JAM subroutine library"
|
||
|
|
.SH NAME
|
||
|
|
JAM_DelSubPacket \- Delete a subfield packet
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
.B #include <jamlib/jam.h>
|
||
|
|
|
||
|
|
.BI "int JAM_DelSubPacket(s_JamSubPacket* " SubPack_PS ");"
|
||
|
|
.RE
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
Frees all memory used by a subfield packet. All subfields in the
|
||
|
|
packet will be lost and the packet handle will not be valid any
|
||
|
|
more.
|
||
|
|
.SS Arguments
|
||
|
|
.TP
|
||
|
|
.I SubPack_PS
|
||
|
|
The subfield packet to delete
|
||
|
|
.SH "RETURN VALUE"
|
||
|
|
.TP
|
||
|
|
.B 0
|
||
|
|
if successful
|
||
|
|
.TP
|
||
|
|
.B JAM_BAD_PARAM
|
||
|
|
if \fISubPack_PS\fP is NULL.
|
||
|
|
.SH EXAMPLES
|
||
|
|
.nf
|
||
|
|
s_JamSubPacket* SubPacket_PS;
|
||
|
|
|
||
|
|
SubPacket_PS = JAM_NewSubPacket();
|
||
|
|
if (!SubPacket_PS) {
|
||
|
|
printf("JAM_NewSubPacket returned NULL.\\n");
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
SubPacket_PS = JAM_DelSubPacket();
|
||
|
|
if (!SubPacket_PS) {
|
||
|
|
printf("JAM_DelSubPacket returned NULL.\\n");
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
.fi
|
||
|
|
.SH 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>.
|
||
|
|
.SH SEE ALSO
|
||
|
|
.BR jamlib (3),
|
||
|
|
.BR JAM_NewSubPacket (3),
|
||
|
|
.BR JAM_GetSubfield (3),
|
||
|
|
.BR JAM_GetSubfield_R (3),
|
||
|
|
.BR JAM_PutSubfield (3)
|
||
|
|
.\" vim: ft=nroff
|