This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.
magicka/jamlib-1.4.7/doc/JAM_WriteLastRead.3
2016-03-22 12:08:00 +10:00

58 lines
1.3 KiB
Groff

.\" $Id: JAM_WriteLastRead.3,v 1.1 2002/11/09 00:37:16 raorn Exp $
.\"
.TH JAM_WriteLastRead 3 2002-11-07 "" "JAM subroutine library"
.SH NAME
JAM_WriteLastRead \- Write a lastread record
.SH SYNOPSIS
.nf
.B #include <jamlib/jam.h>
.BI "int JAM_WriteLastRead(s_JamBase* " Base_PS ","
.BI " ulong " User_I ","
.BI " s_JamLastRead* " Record_PS ");"
.RE
.fi
.SH DESCRIPTION
Writes a lastread record to the lastread file. If the user number
could not be found, the record will be appended to the end of the
file.
.SS Arguments
.TP
.I Base_PS
The message base to use
.TP
.I User_I
A system\-unique user number
.TP
.I Record_PS
A pointer to the lastread struct to be written
.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_BAD_PARAM
if \fIRecord_PS\fP is NULL
.SH EXAMPLES
.nf
int Result_I;
s_JamLastRead LastRead_S;
Result_I = JAM_WriteLastRead(Base_PS, 4711, &LastRead_S);
if (Result_I)
printf("JAM_WriteLastRead returned %d\\n", Result_I);
.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_ReadLastRead (3)
.BR JAM_Errno (3)
.\" vim: ft=nroff