smux_error Subroutine

Purpose

Creates a readable string from the smux_errno global variable value.

Library

SNMP Library (libsnmp.a)

Syntax

#include <isode/snmp/smux.h>

char *smux_error ( error)
int error;

Description

The smux_error subroutine creates a readable string from error code values in the smux_errno global variable in the smux.h file. The smux global variable, smux_errno, is set when an error occurs. The smux_error subroutine can also get a string that interprets the value of the smux_errno variable. The smux_error subroutine can be used to retrieve any numbers, but is most useful interpreting the integers returned in the smux_errno variable.

This subroutine is part of the SNMP Application Programming Interface in the TCP/IP facility.

Parameters

Item Description
error Contains the error to interpret. Usually called with the value of the smux_errno variable, but can be called with any error that is an integer.

Return Values

If the subroutine is successful, a pointer to a static string is returned. If an error occurs, a string of the type SMUX error %s(%d) is returned. The %s value is a string representing the explanation of the error. The %d is the number used to reference that error.