carta
xcb_shm_create_segment_reply(3)

xcb_shm_create_segment_reply3

Asks the server to allocate a shared memory segment.

Part of xcb_shm_create_segment(3).

Usage

Reply datastructure

uint8_t response_type;

uint8_t nfd;

uint16_t sequence;

uint32_t length;

uint8_t pad0 [24] ;

Request arguments

conn

The XCB connection to X11.

shmseg

A shared memory segment ID created with xcb_generate_id().

size

The size of the segment to create.

read_only

True if the server should map the segment read-only; otherwise false.

Reply fields

response_type

The type of this reply, in this case XCB_SHM_CREATE_SEGMENT. This field is also present in the xcb_generic_reply_t and can be used to tell replies apart from each other.

sequence

The sequence number of the last request processed by the X11 server.

length

The length of the reply, in words (a word is 4 bytes).

nfd

The number of file descriptors sent by the server. Will always be 1.

shm_fd

TODO: NOT YET DOCUMENTED.

Overview

Asks the server to allocate a shared memory segment. The server’s reply will include a file descriptor for the client to pass to mmap().

Return value

Returns an xcb_shm_create_segment_cookie_t. Errors have to be handled when calling the reply function xcb_shm_create_segment_reply.

If you want to handle errors in the event loop instead, use xcb_shm_create_segment_unchecked. See xcb-requests(3) for details.

Errors

This request does never generate any errors.

History

  • Arch Linux 2026-11-01 to Debian 13 (Trixie): the text shown here
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch)

Author

Generated from shm.xml. Contact [email protected] for corrections and improvements.

From libxcb 1.17.0-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.