Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
XSetCommand(3)			 XLIB FUNCTIONS 		  XSetCommand(3)

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 con-
     tain  the string list, XGetCommand fills in the argv_return and argc_return
     arguments and returns a nonzero status.  Otherwise, or if any  other  error
     is  encountered,  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 Encoding.  Otherwise, the result
     is  implementation-dependent.   To  free the memory allocated to the string
     list, use XFreeStringList.

PROPERTIES
     WM_COMMAND
	       The command and arguments, null-separated, used to invoke the ap-
	       plication.

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(3),     XAllocIconSize(3),     XAllocSizeHints(3),     XAl-
     locWMHints(3), XSetTransientForHint(3), XSetTextProperty(3),  XSetWMClient-
     Machine(3),   XSetWMColormapWindows(3),  XSetWMIconName(3),  XSetWMName(3),
     XSetWMProperties(3), XSetWMProtocols(3), XStringListToTextProperty(3)
     Xlib - C Language X Interface

X Version 11			  libX11 1.8.13 		  XSetCommand(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XGetCommand&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help