← Back to branch summary

~ubuntu-branches/ubuntu/saucy/nut/saucy

« back to all changes in this revision

Viewing changes to man/upscli_disconnect.3

  • Committer: Bazaar Package Importer
  • Author(s): Arnaud Quette
  • Date: 2004-05-28 13:10:01 UTC
  • mto: (16.1.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040528131001-yj2m9qcez4ya2w14
Tags: upstream-1.4.2
Import upstream version 1.4.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/upscli_disconnect.3
 
1
.TH UPSCLI_DISCONNECT 3 "Sun Oct  6 2002" "" "Network UPS Tools (NUT)"
 
2
.SH NAME
 
3
upscli_disconnect \- disconnect from a UPS server
 
4
.SH SYNOPSIS
 
5
.nf
 
6
.B #include <upsclient.h>
 
7
.sp
 
8
.BI "int upscli_disconnect(UPSCONN *ups);"
 
9
.fi
 
10
.SH DESCRIPTION
 
11
The \fBupscli_disconnect()\fP function takes the pointer \fIups\fP to a
 
12
UPSCONN state structure, shuts down the connection to the server, and 
 
13
frees dynamic memory used by the state structure.  The UPSCONN structure
 
14
is no longer valid after this function is called.
 
15
.PP
 
16
This function must be called, or your program will leak memory and
 
17
file descriptors.
 
18
.SH "RETURN VALUE"
 
19
The \fBupscli_disconnect()\fP function returns 0 on success, or -1 if an
 
20
error occurs.
 
21
.SH "SEE ALSO"
 
22
.BR upscli_connect "(3), " upscli_fd "(3), "
 
23
.BR upscli_strerror "(3), "upscli_upserror "(3) "