Libinfo-330.10.tar.gz
[apple/libinfo.git] / rpc.subproj / getrpcport.3
1 .\" @(#)getrpcport.3r   2.2 88/08/02 4.0 RPCSRC; from 1.12 88/02/26 SMI
2 .\" $FreeBSD: src/lib/libc/rpc/getrpcport.3,v 1.9 2004/07/02 23:52:12 ru Exp $
3 .\"
4 .Dd October 6, 1987
5 .Dt GETRPCPORT 3
6 .Os
7 .Sh NAME
8 .Nm getrpcport
9 .Nd get RPC port number
10 .Sh LIBRARY
11 .Lb libc
12 .Sh SYNOPSIS
13 .In rpc/rpc.h
14 .Ft int
15 .Fn getrpcport "char *host" "int prognum" "int versnum" "int proto"
16 .Sh DESCRIPTION
17 The
18 .Fn getrpcport
19 function
20 returns the port number for version
21 .Fa versnum
22 of the RPC program
23 .Fa prognum
24 running on
25 .Fa host
26 and using protocol
27 .Fa proto .
28 It returns 0 if it cannot contact the portmapper, or if
29 .Fa prognum
30 is not registered.
31 If
32 .Fa prognum
33 is registered but not with version
34 .Fa versnum ,
35 it will still return a port number (for some version of the program)
36 indicating that the program is indeed registered.
37 The version mismatch will be detected upon the first call to the service.