Content-type: text/html Man page of SCF_strerror

SCF_strerror

Section: Smartcard Library Functions (3SMARTCARD)
Updated: 14 May 2002
Index Return to Main Contents
 

NAME

SCF_strerror - get a string describing a status code  

SYNOPSIS

cc [ flag... ] file... -lsmartcard [ library...] 
#include <smartcard/scf.h>

const char *SCF_strerror(SCF_Status_t error);  

PARAMETERS

error A value returned from a smartcard SCF function call. A list of all current codes is contained in <smartcard/scf.h>

 

DESCRIPTION

The SCF_strerror() function provides a mechanism for generating a brief message that describes each SCF_Status_t error code. An application might use the message when displaying or logging errors.

The string returned by the function does not contain any newline characters. Returned strings must not be modified or freed by the caller.  

RETURN VALUES

A pointer to a valid string is always returned. If the provided error is not a valid SCF error code, a string is returned stating that the error code is unknown. A null pointer is never returned.  

EXAMPLES

Example 1: Report a fatal error.

SCF_Status_t status;
SCF_Session_t mySession;
 
status = SCF_Session_getSession(&mySession);
if (status != SCF_STATUS_SUCCESS) {
    printf("Smartcard startup error: %s\n", SCF_strerror(status));
    exit(1);
}
 
/* ... */

 

USAGE

Messages returned from SCF_strerror() are in the native language specified by the LC_MESSAGES locale category; see setlocale(3C). The C locale is used if the native strings could not be loaded.  

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelMT-Safe

 

SEE ALSO

libsmartcard(3LIB), SCF_Session_getSession(3SMARTCARD), strerror(3C), attributes(5)


 

Index

NAME
SYNOPSIS
PARAMETERS
DESCRIPTION
RETURN VALUES
EXAMPLES
USAGE
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:38:33 GMT, October 02, 2010