XStoreBytes(3X) — X Version 11

NAME

XStoreBytes, XStoreBuffer, XFetchBytes, XFetchBuffer, XRotateBuffers − manipulate cut and paste buffers

SYNTAX

XStoreBytes(display, bytes, nbytes)
      Display ∗display;
      char bytes[];
      int nbytes;

XStoreBuffer(display, bytes, nbytes, buffer)
      Display ∗display;
      char bytes[];
      int nbytes;
      int buffer;

char ∗XFetchBytes(display, nbytes_return)
Display ∗display;
int ∗nbytes_return;

char ∗XFetchBuffer(display, nbytes_return, return_buffer)
      Display ∗display;
      int ∗nbytes_return;
      int return_buffer;

XRotateBuffers(display, rotate)
Display ∗display;
int rotate;

ARGUMENTS

bufferSpecifies the buffer in which you want to store the byte string.

bytesSpecifies the string of bytes you want stored. The byte string is not necessarily ASCII or null-terminated.

displaySpecifies the connection to the X server.

nbytesSpecifies the number of bytes of the bytes argument that you want stored.

nbytes_return
Returns the number of bytes in the string in the buffer.

return_bufferSpecifies which buffer you want to stored data to be returned from.

rotateSpecifies how much to rotate the cut buffer.

DESCRIPTION

The XStoreBytes function returns the number of bytes to be stored to the nbytes argument. .PN XStoreBytes can generate BadAlloc and BadWindow errors.

The XStoreBuffer function stores data in a specified cut buffer. .PN XStoreBuffer can generate BadAlloc, BadAtom, and BadWindow errors.

The XFetchBytes function returns the number of bytes in the nbytes argument, if the buffer contains data. Otherwise, the function returns NULL and sets nbytes to 0. .PN XFetchBytes can generate a BadWindow error.

The XFetchBuffer function returns the value zero to the nbytes argument if there is no data in the buffer. .PN XFetchBuffer can generate a BadValue error.

The XRotateBuffers function rotates the cut buffers, such that buffer 0 becomes buffer n, buffer 1 becomes n+1 mod 8, and so on. This cut buffer numbering is global to the display. .PN XRotateBuffers can generate BadAtom, BadMatch, and BadWindow errors.

DIAGNOSTICS

BadAlloc The server failed to allocate the requested resource or server memory.

BadAtom A value for an Atom argument does not name a defined Atom.

BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request.

BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument’s type is accepted. Any argument defined as a set of alternatives can generate this error.

BadWindow A value for a Window argument does not name a defined Window.