screen_create_group()

Create a group

Synopsis:

#include <screen/screen.h>
int screen_create_group(screen_group_t *pgrp,
                        screen_context_t ctx)

Arguments:

pgrp
The handle of the group.
ctx
The connection to Screen. This context must have been created with screen_create_context().

Library:

libscreen

Description:

Function Type: Immediate Execution

This function creates a group that windows or pixmaps can join. You can use groups in order to organize your application windows and pixmaps. Use screen_join_window_group() and screen_join_pixmap_group() to join a window or pixmap respectively to a group.

Windows and pixmaps that wish to join this group will use the name of this group (retrieved by calling screen_get_group_property_cv() the SCREEN_PROPERTY_NAME) when joining to it (by calling the appropriate screen_join_*_group() function).

Call screen_destroy_group() when you no longer need the group.

Returns:

0 if successful, or -1 if an error occurred (errno is set; refer to errno.h for more details).