XSetCommand(3X11) — NEWS-OS Programmer’s Manual

NAME

XSetCommand, XGetCommand − set or read a window’s WM_COMMAND property

SYNTAX

XSetCommand(display, w, argv, argc)
      Display ∗display;
      Window w;
      char ∗∗argv;
      int argc; Status XGetCommand(display, w, argv_return, argc_return)
      Display ∗display;
      Window w;
      char ∗∗∗argv_return;
      int ∗argc_return;

ARGUMENTS

argcSpecifies the number of arguments.

argc_returnReturns the number of arguments returned.

argvSpecifies the application’s argument list.

argv_returnReturns the application’s argument list.

displaySpecifies the connection to the X server.

wSpecifies 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.) 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 non-zero status. Otherwise, it returns a zero status. To free the memory allocated to the string list, use XFreeStringList.

PROPERTIES

WM_COMMAND
The command and arguments, separated by ASCII nulls, used to invoke the application.

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.

Museum

Related Articles