GETRPCENT_R

Section: Linux Programmer's Manual (3)
Updated: 2008-08-19
Index Return to Main Contents

NAME

getrpcent_r, getrpcbyname_r, getrpcbynumber_r - get RPC entry (reentrant)

SYNOPSIS

#include <netdb.h>

int getrpcent_r(struct rpcent *result_buf, char *buf,
                size_t buflen, struct rpcent **result);

int getrpcbyname_r(const char *name,
                struct rpcent *result_buf, char *buf,
                size_t buflen, struct rpcent **result);

int getrpcbynumber_r(int number,
                struct rpcent *result_buf, char *buf,
                size_t buflen, struct rpcent **result);

Feature Test Macro Requirements for glibc (see feature_test_macros(7)):

getrpcent_r(), getrpcbyname_r(), getrpcbynumber_r(): _BSD_SOURCE || _SVID_SOURCE

DESCRIPTION

The getrpcent_r(), getrpcbyname_r(), and getrpcbynumber_r() functions are the reentrant equivalents of, respectively, getrpcent(3), getrpcbyname(3), and getrpcbynumber(3). They differ in the way that the rpcent structure is returned, and in the function calling signature and return value. This manual page describes just the differences from the non-reentrant functions.

Instead of returning a pointer to a statically allocated rpcent structure as the function result, these functions copy the structure into the location pointed to by result_buf.

The buf array is used to store the string fields pointed to by the returned rpcent structure. (The non-reentrant functions allocate these strings in static storage.) The size of this array is specified in buflen. If buf is too small, the call fails with the error ERANGE, and the caller must try again with a larger buffer. (A buffer of length 1024 bytes should be sufficient for most applications.)

If the function call successfully obtains an RPC record, then *result is set pointing to result_buf; otherwise, *result is set to NULL.

RETURN VALUE

On success, these functions return 0. On error, a positive error number is returned.

On error, record not found (getrpcbyname_r(), getrpcbynumber_r()), or end of input (getrpcent_r()) result is set to NULL.

ERRORS

ENOENT: (getrpcent_r()) No more records in database.
ERANGE: buf is too small. Try again with a larger buffer (and increased buflen).

CONFORMING TO

These functions are GNU extensions. Functions with similar names exist on some other systems, though typically with different calling signatures.

COLOPHON

This page is part of release 3.22 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/.