nut-debian/docs/man/upscli_splitaddr.txt
2011-01-26 10:35:08 +01:00

55 lines
1.1 KiB
Plaintext

UPSCLI_SPLITADDR(3)
===================
NAME
----
upscli_splitaddr - split a listening address into its components
SYNOPSIS
--------
#include <upsclient.h>
int upscli_splitaddr(const char *buf, char **hostname,
int *port)
DESCRIPTION
-----------
The *upscli_splitaddr()* function takes a pointer to the raw UPS
definition 'buf' and returns pointers to dynamically allocated
memory in 'upsname' and 'hostname'. It also copies the port
number into 'port'.
FORMATTING
----------
A listening address definition is specified according to this format:
<hostname>[:<port>]
Definitions without an explicit port value receive the default value of
3493.
MEMORY USAGE
------------
You must *free*(3) the pointer 'hostname' when you are done
with it to avoid memory leaks.
RETURN VALUE
------------
The *upscli_splitaddr()* function returns 0 on success, or -1 if an
error occurs.
SEE ALSO
--------
linkman:upscli_fd[3], linkman:upscli_get[3],
linkman:upscli_readline[3], linkman:upscli_sendline[3],
linkman:upscli_splitname[3], linkman:upscli_ssl[3],
linkman:upscli_strerror[3], linkman:upscli_upserror[3]