| 1 | .\" $Id: al_strerror.3,v 1.2 1998-01-26 06:35:53 danw Exp $ |
|---|
| 2 | .\" |
|---|
| 3 | .\" Copyright 1997 by the Massachusetts Institute of Technology. |
|---|
| 4 | .\" |
|---|
| 5 | .\" Permission to use, copy, modify, and distribute this |
|---|
| 6 | .\" software and its documentation for any purpose and without |
|---|
| 7 | .\" fee is hereby granted, provided that the above copyright |
|---|
| 8 | .\" notice appear in all copies and that both that copyright |
|---|
| 9 | .\" notice and this permission notice appear in supporting |
|---|
| 10 | .\" documentation, and that the name of M.I.T. not be used in |
|---|
| 11 | .\" advertising or publicity pertaining to distribution of the |
|---|
| 12 | .\" software without specific, written prior permission. |
|---|
| 13 | .\" M.I.T. makes no representations about the suitability of |
|---|
| 14 | .\" this software for any purpose. It is provided "as is" |
|---|
| 15 | .\" without express or implied warranty. |
|---|
| 16 | .\" |
|---|
| 17 | .TH AL_STRERROR 3 "18 September 1997" |
|---|
| 18 | .SH NAME |
|---|
| 19 | al_strerror, al_free_errmem \- Obtain a string representation of a |
|---|
| 20 | login library error or warning code |
|---|
| 21 | .SH SYNOPSIS |
|---|
| 22 | .nf |
|---|
| 23 | .B #include <al.h> |
|---|
| 24 | .PP |
|---|
| 25 | .B const char *al_strerror(int \fIcode\fP, char **\fImemptr\fP) |
|---|
| 26 | .B void al_free_errmem(char *\fImem\fP) |
|---|
| 27 | .PP |
|---|
| 28 | .B cc file.c -lal -lhesiod |
|---|
| 29 | .fi |
|---|
| 30 | .SH DESCRIPTION |
|---|
| 31 | The |
|---|
| 32 | .I al_strerror |
|---|
| 33 | function obtains a string representation of the error or warning code |
|---|
| 34 | .IR code . |
|---|
| 35 | It may allocate memory for the returned string and place a pointer to |
|---|
| 36 | the allocated memory in the variable pointed to by |
|---|
| 37 | .IR memptr . |
|---|
| 38 | The caller must invoke |
|---|
| 39 | .I al_free_errmem |
|---|
| 40 | with the variable pointed to by |
|---|
| 41 | .I memptr |
|---|
| 42 | after the error string is used. |
|---|
| 43 | .SH SEE ALSO |
|---|
| 44 | al_login_allowed(3), al_acct_create(3), al_acct_revert(3) |
|---|
| 45 | .SH AUTHOR |
|---|
| 46 | Greg Hudson, MIT Information Systems |
|---|
| 47 | .br |
|---|
| 48 | Copyright 1997 by the Massachusetts Institute of Technology. |
|---|
