NAME

jagent - host control of windowing terminal

SYNOPSIS

#include <sys/jioctl.h>

int ioctl (int cntlfd, JAGENT, &arg);

DESCRIPTION

The ioctl system call, when performed on an xt(7) device with the JAGENT request, allows a host program to send information to a windowing terminal. ioctl has three arguments:

cntlfd the xt(7) control channel file descriptor

JAGENT the xt ioctl request to invoke a windowing terminal agent routine.

&arg the address of a bagent structure, defined in <sys/jioctl.h> as follows:

struct  bagent {
  int   size;  /* size of src in & dest out */
  char  *src;  /* the source byte string */
  char  *dest; /* the destination byte string */
};

The src pointer must be initialized to point to a byte string that is sent to the windowing terminal. See layers(5) for a list of JAGENT strings recognized by windowing terminals. Likewise, the dest pointer must be initialized to the address of a buffer to receive a byte string returned by the terminal. When ioctl is called, the size argument must be set to the length of the src string. Upon return, size is set by ioctl to the length of the destination byte string, dest.

SEE ALSO

ioctl(2), libwindows(3X), layers(5).
xt(7) in the Programmer's Guide: STREAMS.

DIAGNOSTICS

Upon successful completion, a non-negative value, the size of the destination byte string, is returned. If an error occurs, -1 is returned.