Blame doc/ieee1284_ref.3

Packit d36e9b
.\"     Title: ieee1284_ref
Packit d36e9b
.\"    Author: Tim Waugh <twaugh@redhat.com>
Packit d36e9b
.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
Packit d36e9b
.\"      Date: 09/18/2007
Packit d36e9b
.\"    Manual: Functions
Packit d36e9b
.\"    Source: 
Packit d36e9b
.\"
Packit d36e9b
.TH "IEEE1284_REF" "3" "09/18/2007" "" "Functions"
Packit d36e9b
.\" disable hyphenation
Packit d36e9b
.nh
Packit d36e9b
.\" disable justification (adjust text to left margin only)
Packit d36e9b
.ad l
Packit d36e9b
.SH "NAME"
Packit d36e9b
ieee1284_ref, ieee1284_unref \- modify a port's reference count
Packit d36e9b
.SH "SYNOPSIS"
Packit d36e9b
.sp
Packit d36e9b
.ft B
Packit d36e9b
.nf
Packit d36e9b
#include <ieee1284.h>
Packit d36e9b
.fi
Packit d36e9b
.ft
Packit d36e9b
.HP 17
Packit d36e9b
.BI "int ieee1284_ref(struct\ parport\ *" "port" ");"
Packit d36e9b
.HP 19
Packit d36e9b
.BI "int ieee1284_unref(struct\ parport\ *" "port" ");"
Packit d36e9b
.SH "DESCRIPTION"
Packit d36e9b
.PP
Packit d36e9b
If you want to free the port list from
Packit d36e9b
\fBieee1284_find_ports\fR
Packit d36e9b
but open one of the ports later on, you will need to prevent it from being destroyed in
Packit d36e9b
\fBieee1284_free_ports\fR. Each port has a reference count, and you can use
Packit d36e9b
\fBieee1284_ref\fR
Packit d36e9b
to increment it and
Packit d36e9b
\fBieee1284_unref\fR
Packit d36e9b
to decrement it.
Packit d36e9b
.PP
Packit d36e9b
If you use
Packit d36e9b
\fBieee1284_ref\fR
Packit d36e9b
at any stage, you must later call
Packit d36e9b
\fBieee1284_unref\fR
Packit d36e9b
to relinquish the extra reference. If you do not do this, the resources associated with the port will not be cleaned up.
Packit d36e9b
.PP
Packit d36e9b
If you have not previously used
Packit d36e9b
\fBieee1284_ref\fR
Packit d36e9b
on a port, you must not use
Packit d36e9b
\fBieee1284_unref\fR
Packit d36e9b
on it.
Packit d36e9b
.SH "RETURN VALUE"
Packit d36e9b
.PP
Packit d36e9b
These functions return the number of references held after the increment or decrement.
Packit d36e9b
.SH "SEE ALSO"
Packit d36e9b
.PP
Packit d36e9b
\fBieee1284_open\fR(3)
Packit d36e9b
.SH "AUTHOR"
Packit d36e9b
.PP
Packit d36e9b
\fBTim Waugh\fR <\&twaugh@redhat.com\&>
Packit d36e9b
.sp -1n
Packit d36e9b
.IP "" 4
Packit d36e9b
Author.
Packit d36e9b
.SH "COPYRIGHT"
Packit d36e9b
Copyright \(co 2001\-2003 Tim Waugh
Packit d36e9b
.br
Packit d36e9b