Digital

NAME

X29GetAction − Reads the action to be performed when a specified event occurs. 

LIBRARY

X.25 Library (libx25.a)

SYNOPSIS

#include <netx25/x29.h>
int X29GetAction(

int td ,
unsigned char event ,
X29ActionFlags ∗actionFlags ,
char ∗message ,
unsigned short ∗messageLength );

PARAMETERS

tdIdentifies the X.29 terminal for which the action is to be read. 
 

eventPoints to one of the following events:

X29E_BREAK
a break message is sent from the remote PAD

X29E_INTERRUPT
an interrupt is sent from the remote PAD

actionFlags
Points to one or a combination of the following actions:

X29A_CLEAR
Clear the X.29 call.

X29A_PURGE
Purge any data pending for terminal.

X29A_RESET
Reset the X.29 call.

messagePoints to the message to output to terminal on receipt of this event. 
 

messageLength
Points to the size of the character array pointed to by the message when the routine is called, or the size of the message string when the function is returned.
 

DESCRIPTION

The X29GetAction routine reads the action to be performed on receipt of a break message (X29E_BREAK) or interrupt (X29E_INTERRUPT) from the remote PAD. 

The action to be performed can be one or a combination of the following:

       •Clear the X.29 call (X29A_CLEAR)

       •Purge any data pending for the terminal (X29A_PURGE)

       •Reset the X.29 call (X29A_RESET)
 

RETURN VALUES

Upon successful completion, the X29GetAction routine returns a value of 0.  Otherwise, a (negative) error code is returned. 
 

ERRORS

 
If the X29GetAction routine fails, one of the following error codes is returned:

[X25RC_SYSERR]
An operating system error occurred.  The external variable errno is set to indicate the error. 

[X25RC_USRBUFSIZE]
User-supplied buffer too small for return value.

[X29RC_INVALEVENT]
No such X.29 event.

[X29RC_NOTTY]
The terminal specified is not an X.29 terminal.
 

RELATED INFORMATION

Functions: X29SetAction(3X25). 
Files: x29remoteprof(4X25). 

X.25 for Digital UNIX − Programmer’s Reference Manual.