csx_Error2Text(9f)

1csx_Error2Text(9F)       Kernel Functions for Drivers       csx_Error2Text(9F)
2
3
4

NAME

6       csx_Error2Text - convert error return codes to text strings
7

SYNOPSIS

9       #include <sys/pccard.h>
10
11
12
13       int32_t csx_Error2Text(error2text_t *er);
14
15

INTERFACE LEVEL

17       Solaris DDI Specific (Solaris DDI)
18

PARAMETERS

20       er     Pointer to an error2text_t structure.
21
22

DESCRIPTION

24       This  function  is  a Solaris-specific extension that provides a method
25       for clients to  convert  Card  Services  error  return  codes  to  text
26       strings.
27

STRUCTURE MEMBERS

29       The structure members of error2text_t are:
30
31         uint32_t     item;                             /*the error code*/
32         char         test[CS_ERROR_MAX_BUFSIZE};       /*the error code*/
33
34
35
36       A  pointer  to  the text for the Card Services error return code in the
37       item field is returned in the text field if the error  return  code  is
38       found.  The  client  is not responsible for allocating a buffer to hold
39       the text. If the Card Services error return code specified in the  item
40       field is not found, the text field will be set to a string of the form:
41
42
43       "{unknown Card Services return code}"
44

RETURN VALUES

46       CS_SUCCESS                  Successful operation.
47
48
49       CS_UNSUPPORTED_FUNCTION     No PCMCIA hardware installed.
50
51

CONTEXT

53       This function may be called from user or kernel context.
54

EXAMPLES

56       Example 1 : Using the csxError2Text function
57
58         if ((ret = csx_RegisterClient(&client_handle, &
59                 client_reg)) != CS_SUCCESS)
60         {
61            error2text_t error2text;
62            error2text.item = ret;
63            csx_Error2Text(&error2text);
64            cmn_err(CE_CONT, "RegisterClient failed %s (0x%x)",
65                 error2text.text, ret);
66         }
67
68