47 lines
1.2 KiB
Groff
47 lines
1.2 KiB
Groff
|
.\" $Id: JAM_DeleteMessage.3,v 1.1 2002/11/09 00:37:16 raorn Exp $
|
||
|
|
.\"
|
||
|
|
.TH JAM_DeleteMessage 3 2002-11-07 "" "JAM subroutine library"
|
||
|
|
.SH NAME
|
||
|
|
JAM_DeleteMessage \- Delete message from messagebase
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
.B #include <jamlib/jam.h>
|
||
|
|
|
||
|
|
.BI "int JAM_DeleteMessage(s_JamBase* " Base_PS ","
|
||
|
|
.BI " ulong " MsgNo_I ");"
|
||
|
|
.RE
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
Deletes message from messagebase by setting \fIHdrOffset\fP and \fIUserCRC\fP
|
||
|
|
in index to 0xFFFFFFFF. \fIActiveMsgs\fP in base header also updated.
|
||
|
|
.SS Arguments
|
||
|
|
.TP
|
||
|
|
.I Base_PS
|
||
|
|
The message base to use
|
||
|
|
.TP
|
||
|
|
.I MsgNo_I
|
||
|
|
The absolute message number. Message #0 is the first in the message base.
|
||
|
|
.SH "RETURN VALUE"
|
||
|
|
.TP
|
||
|
|
.B 0
|
||
|
|
if successful
|
||
|
|
.TP
|
||
|
|
.B JAM_IO_ERROR
|
||
|
|
if an I/O error occured. See
|
||
|
|
.BR JAM_Errno (3)
|
||
|
|
.TP
|
||
|
|
.B JAM_NOT_LOCKED
|
||
|
|
if the message base is not locked
|
||
|
|
.SH NOTES
|
||
|
|
This funtion is available since JAMlib 1.4.0.
|
||
|
|
.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_AddMessage (3),
|
||
|
|
.BR JAM_AddEmptyMessage (3),
|
||
|
|
.BR JAM_Errno (3)
|
||
|
|
.\" vim: ft=nroff
|