AGetErrorText(3X) — Series 700 Only

NAME

AGetErrorText − copy error description into specified buffer

SYNOPSIS

#include <audio/Alib.h>

void AGetErrorText (

Audio *audio,

AError error,

char *buffer_return,

int buffer_length

);

DESCRIPTION

AGetErrorText() copies the description for the error specified in error to the buffer specified in buffer_return. The error description is a null-terminated string.

audio specifies the Audio structure associated with this connection.

error specifies the type of error.

buffer_return receives the error description.

buffer_length specifies the size of buffer_return.

ERRORS

AGetErrorText() does not return an error status.

EXAMPLES

The following example gets the error description for AEBadOffset and returns it in buffer_return:

#define TEXT_LENGTH 256
Audio *audio; /* audio connection */
AError err; /* type of error */
char buffer_return[TEXT_LENGTH]; /* buffer for description */
.
.
.
/* get error description */
err = AEBadOffset
AGetErrorText(audio, err, &buffer_return, TEXT_LENGTH);

DEPENDENCIES

This function belongs to the Audio Library of functions that manage connections to an audio server. The audio server must run on a system that has audio hardware. To find out whether or not your system has audio hardware, refer to the hardware manual that accompanies your system.

AUTHOR

AGetErrorText() was developed by HP.

Museum