MirBSD manpage: XGetCommand(3), XSetCommand(3)


XSetCommand(3X11)        XLIB FUNCTIONS         XSetCommand(3X11)

NAME

     XSetCommand, XGetCommand - set or read a window's WM_COMMAND
     property

SYNTAX

     int XSetCommand(Display *display, Window w, char **argv, int
          argc);

     Status XGetCommand(Display *display, Window w, char
          ***argv_return, int *argc_return);

ARGUMENTS

     argc      Specifies the number of arguments.

     argc_return
               Returns the number of arguments returned.

     argv      Specifies the application's argument list.

     argv_return
               Returns the application's argument list.

     display   Specifies the connection to the X server.

     w         Specifies the window.

DESCRIPTION

     The XSetCommand function sets the command and arguments used
     to invoke the application. (Typically, argv is the argv
     array of your main program.) If the strings are not in the
     Host Portable Character Encoding, the result is
     implementation-dependent.

     XSetCommand can generate BadAlloc and BadWindow errors.

     The XGetCommand function reads the WM_COMMAND property from
     the specified window and returns a string list. If the
     WM_COMMAND property exists, it is of type STRING and format
     8. If sufficient memory can be allocated to contain the
     string list, XGetCommand fills in the argv_return and
     argc_return arguments and returns a nonzero status. Other-
     wise, it returns a zero status. If the data returned by the
     server is in the Latin Portable Character Encoding, then the
     returned strings are in the Host Portable Character Encod-
     ing. Otherwise, the result is implementation-dependent. To
     free the memory allocated to the string list, use XFreeS-
     tringList.

PROPERTIES

     WM_COMMAND
               The command and arguments, null-separated, used to
               invoke the application.

XFree86                   Version 4.5.0                         1

XSetCommand(3X11)        XLIB FUNCTIONS         XSetCommand(3X11)

DIAGNOSTICS

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

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

SEE ALSO

     XAllocClassHint(3X11), XAllocIconSize(3X11),
     XAllocSizeHints(3X11), XAllocWMHints(3X11),
     XSetTransientForHint(3X11), XSetTextProperty(3X11),
     XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11),
     XSetWMIconName(3X11), XSetWMName(3X11),
     XSetWMProperties(3X11), XSetWMProtocols(3X11),
     XStringListToTextProperty(3X11)
     Xlib - C Language X Interface

XFree86                   Version 4.5.0                         2

Generated on 2021-12-07 11:07:08 by $MirOS: src/scripts/roff2htm,v 1.103 2021/01/23 20:24:35 tg Exp $ — This product includes material provided by mirabilos.

These manual pages and other documentation are copyrighted by their respective writers; their sources are available at the project’s CVSweb, AnonCVS and other mirrors. The rest is Copyright © 2002–2021 MirBSD.

This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report — diffs preferred.