Previous: , Up: Output Library Types   [Index]


7.10.2.3 struct x1f4_textpipe_type

typedef struct x1f4_textpipe_type {
    const char *name;
    int (*copy)(void *, const char *, unsigned);
    unsigned size;
    void *text;
} x1f4_textpipe_type;

The x1f4_textpipe_type record describes an output device. It details such (application and programming language) output device attributes as prefix id, and data operations such as byte string output.

See Referable Objects.

name

The name field is the output device prefix id, i.e. the string used for prefixing the device specific output routines.

size

The size field is the output device prefix id length, i.e. the number of characters (not including the terminal null) making up the output device prefix id.

text

The text field is the output device context. It is passed as argument to the copy output method and not used otherwise.

copy

The copy field is the address of the routine outputting some byte string on the device corresponding this very definition. When called, the copy routine is supplied the device context, (the text field in this very record), the address at which the byte string to be output is stored and its size, in this order.

The method is expected to return zero for success, non zero for failure (one of the error class codes).

See Error Classes.