IBM Systems - iSeries Remote Procedure Call (RPC) APIs Version 5 Release 4 IBM Systems - iSeries Remote Procedure Call (RPC) APIs Version 5 Release 4 Note Before using this information and the product it supports, be sure to read the information in “Notices,” on page 121. Sixth Edition (February 2006) This edition applies to version 5, release 4, modification 0 of IBM i5/OS (product number 5722-SS1) and to all subsequent releases and modifications until otherwise indicated in new editions. This version does not run on all reduced instruction set computer (RISC) models nor does it run on CISC models. © Copyright International Business Machines Corporation 1998, 2006. All rights reserved. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Contents Remote Procedure Call (RPC) APIs . .1 Authorities . .13 Authentication APIs . .1 Return Value . .13 APIs . .2 Error Conditions. .13 authnone_create()—Create Null Authentication . .2 Error Messages . .14 Parameters . .2 Example . .14 Authorities . .2 netdir_sperror()—Indicate an Error in an NTA Return Value . .2 Routine. .15 Error Conditions . .2 Parameters . .15 Error Messages . .2 Authorities . .15 Related Information . .3 Return Value . .15 Example . .3 Error Messages . .15 authsys_create()—Create Authentication with OS Usage Notes . .15 Permission . .3 Example . .15 Parameters . .3 taddr2uaddr()—Translate a Local Address . .16 Authorities . .4 Parameters . .16 Return Value . .4 Authorities . .16 Error Conditions . .4 Return Value . .16 Error Messages . .4 Error Conditions. .17 Related Information . .4 Error Messages . .17 Example . .4 Usage Notes . .17 auth_destroy()—Destroy Authentication Information 5 Example . .17 Parameters . .5 uaddr2taddr()—Translate a Universal Address. .18 Authorities . .5 Parameters . .18 Return Value . .6 Authorities . .18 Error Conditions . .6 Return Value . .19 Error Messages . .6 Error Conditions. .19 Related Information . .6 Error Messages . .19 Example . .6 Usage Notes . .19 Name-to-Address Translation APIs . .7 Example . .19 netdir_free()—Free Netdir Structures . .7 Network Selection APIs . .20 Parameters . .7 endnetconfig()—Release the Pointer in the Netconfig Authorities . .8 File . .20 Error Conditions . .8 Parameters . .21 Error Messages . .8 Authorities . .21 Usage Notes . .8 Return Value . .21 netdir_getbyaddr()—Translate a Netbuf Address to a Error Conditions. .21 Host . .8 Error Messages . .21 Parameters . .8 Usage Notes . .21 Authorities . .9 Example . .21 Return Value . .9 freenetconfigent()—Free the Netconfig Structure . .22 Error Conditions . .9 Parameters . .23 Error Messages . .9 Authorities . .23 Usage Notes . .9 Return Value . .23 Example . .9 Error Conditions. .23 netdir_getbyname()—Translate a Given Host-Service Error Messages . .23 Pair . .10 Example . .23 Parameters . .11 getnetconfig()—Return Current Record from the Authorities . .11 Netconfig File . .24 Return Value . .11 Parameters . .24 Error Conditions . .11 Authorities . .24 Error Messages . .11 Return Value . .24 Usage Notes . .11 Error Conditions. .25 Example . .11 Error Messages . .25 netdir_options()—Access Transport-Specific Example . .25 Capabilities . .12 getnetconfigent()—Return a Pointer to a Netconfig Parameters . .13 Structure . .25 © Copyright IBM Corp. 1998, 2006 iii Parameters . .25 Example . .42 Authorities . .25 clnt_destroy()—Destroy the RPC Client’s Handle . .42 Return Value . .25 Parameters . .42 Error Conditions . .26 Authorities . .43 Error Messages . .26 Return Value . .43 Usage Notes . .27 Error Conditions . .43 Example . .27 Error Messages . .43 setnetconfig()—Initialize the Pointer in the Netconfig Related Information . .43 File . .27 Example . .43 Parameters . .27 svc_create()—Create a Server Handle . .43 Authorities . .27 Parameters . .44 Return Value . .27 Authorities . .44 Error Conditions. .28 Return Value . .44 Error Messages . .28 Error Conditions . .44 Usage Notes . .29 Error Messages . .44 Example . .29 Related Information . .45 Transport-Independent Remote Procedure Call APIs 29 Example . .45 Simplified APIs . .29 svc_destroy()—Destroy an RPC Service Transport rpc_call()—Call a Remote Procedure on the Handle . .45 Specified System. .29 Parameters . .46 Parameters . .30 Authorities . .46 Authorities . .30 Return Value . .46 Return Value . .30 Error Conditions . .46 Error Conditions. .31 Error Messages . .46 Error Messages . .31 Related Information . .46 Related Information . .31 Example . .46 Example . .31 Intermediate-level APIs . .46 rpc_reg()—Register a Procedure with RPC Service clnt_tp_create()—Create a Client Handle . .47 Package . .32 Parameters . .47 Parameters . .32 Authorities . .47 Authorities . .33 Return Value . .47 Return Value . .33 Error Conditions . .47 Error Conditions. .33 Error Messages . .48 Error Messages . .33 Related Information . .49 Related Information . .33 Example . .49 Example . .33 svc_tp_create()—Create a Server Handle . .49 Top-level APIs . .34 Parameters . .50 clnt_call()—Call a Remote Procedure Associated Authorities . .50 with the Client . .34 Return Value . .50 Parameters . .35 Error Conditions . .50 Authorities . .35 Error Messages . .50 Return Value . .35 Related Information . .50 Error Conditions. .35 Example . .51 Error Messages . .36 Expert-level APIs . .51 Related Information . .37 clnt_tli_create()—Create a Client Handle . .52 Example . .37 Parameters . .52 clnt_control()—Change Information about a Client Authorities . .53 Object . .37 Return Value . .53 Parameters . .38 Error Conditions . .53 Authorities . .38 Error Messages . .54 Return Value . .38 Related Information . .55 Error Conditions. .39 Example . .55 Error Messages . .39 rpcb_getaddr()—Find the Universal Address of a Example . .39 Service . .55 clnt_create()—Create a Generic Client Handle . .39 Parameters . .56 Parameters . .40 Authorities . .56 Authorities . .40 Return Value . .56 Return Value . .40 Error Conditions . .56 Error Conditions. .40 Error Messages . .57 Error Messages . .41 Example . .57 Related Information . .42 iv IBM Systems - iSeries: Remote Procedure Call (RPC) APIs rpcb_set()—Register the Server Address with the Authorities . .72 RPCBind . .58 Return Value . .72 Parameters . .58 Error Conditions . .72 Authorities . .58 Error Messages . .72 Return Value . .58 Example . .72 Error Conditions. .58 svcerr_noproc()—Send Information to Client for Error Messages . .59 Procedure Number Error . .72 Related Information . .59 Parameters . .72 Example . .59 Authorities . .72 rpcb_unset()—Unregister Their Addresses . .60 Return Value . .73 Parameters . .60 Error Conditions . .73 Authorities . .60 Error Messages . .73 Return Value . .60 Example . ..