clnt_sperrno Subroutine

Communications Technical Reference, Volume 1

clnt_sperrno Subroutine

Purpose

Specifies the condition of the stat parameter by returning a pointer to a string containing a status message.

Library

C Library (libc.a)

Syntax

#include <rpc/rpc.h>

char *clnt_sperrno (stat)
enum clnt_stat stat;

Description

The clnt_sperrno subroutine specifies the condition of the stat parameter by returning a pointer to a string containing a status message. The string ends with a new-line character.

Whenever one of the following conditions exists, the clnt_sperrno subroutine is used instead of the clnt_perrno subroutine when a callrpc routine fails:

The program does not have a standard error output. This is common for programs running as servers.
The programmer does not want the message to be output with the printf subroutine.
A message format differing from that supported by the clnt_perrno subroutine is being used.
Note: The clnt_sperrno subroutine does not return the pointer to static data, so the result is not overwritten on each call.

Parameters

stat

Specifies the client error status of the remote procedure call.

Return Values

The clnt_sperrno subroutine translates and displays the following enum clnt_stat error status messages:

RPC_SUCCESS = 0	Call succeeded.
RPC_CANTENCODEARGS = 1	Cannot encode arguments.
RPC_CANTDECODERES = 2	Cannot decode results.
RPC_CANTSEND = 3	Failure in sending call.
RPC_CANTRECV = 4	Failure in receiving result.
RPC_TIMEDOUT = 5	Call timed out.

Implementation Specifics

This subroutine is part of Base Operating System (BOS) Runtime.

Related Information

The clnt_perrno subroutine.

List of RPC Programming References.

Remote Procedure Call (RPC) Overview for Programming in AIX Version 4.3 Communications Programming Concepts.