xref: /openbsd-src/lib/libc/rpc/getrpcport.3 (revision a28daedfc357b214be5c701aa8ba8adb29a7f1c2)
1.\"	$OpenBSD: getrpcport.3,v 1.8 2007/05/31 19:19:30 jmc Exp $
2.\"
3.\" Sun RPC is a product of Sun Microsystems, Inc. and is provided for
4.\" unrestricted use provided that this legend is included on all tape
5.\" media and as a part of the software program in whole or part.  Users
6.\" may copy or modify Sun RPC without charge, but are not authorized
7.\" to license or distribute it to anyone else except as part of a product or
8.\" program developed by the user.
9.\"
10.\" SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
11.\" WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
12.\" PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
13.\"
14.\" Sun RPC is provided with no support and without any obligation on the
15.\" part of Sun Microsystems, Inc. to assist in its use, correction,
16.\" modification or enhancement.
17.\"
18.\" SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
19.\" INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
20.\" OR ANY PART THEREOF.
21.\"
22.\" In no event will Sun Microsystems, Inc. be liable for any lost revenue
23.\" or profits or other special, indirect and consequential damages, even if
24.\" Sun has been advised of the possibility of such damages.
25.\"
26.\" Sun Microsystems, Inc.
27.\" 2550 Garcia Avenue
28.\" Mountain View, California  94043
29.\"
30.Dd $Mdocdate: May 31 2007 $
31.Dt GETRPCPORT 3
32.Os
33.Sh NAME
34.Nm getrpcport
35.Nd get RPC port number
36.Sh SYNOPSIS
37.Fd #include <rpc/rpc.h>
38.Ft int
39.Fn getrpcport "char *host" "int prognum" "int versnum" "int proto"
40.Sh DESCRIPTION
41.Fn getrpcport
42returns the port number for version
43.Fa versnum
44of the RPC program
45.Fa prognum
46running on
47.Fa host
48and using protocol
49.Fa proto .
50It returns 0 if it cannot contact the portmapper, or if
51.Fa prognum
52is not registered.
53If
54.Fa prognum
55is registered but not with version
56.Fa versnum ,
57it will still return a port number (for some version of the program)
58indicating that the program is indeed registered.
59The version mismatch will be detected upon the first call to the service.
60