Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tk_GetOption (3tk)

Name

Tk_GetOption - retrieve an option from the option database

Synopsis

#include <tk.h>

Tk_Uid
Tk_GetOption(tkwin, name, class)

Description

Tk_GetOption(3tk)            Tk Library Procedures           Tk_GetOption(3tk)



______________________________________________________________________________

NAME
       Tk_GetOption - retrieve an option from the option database

SYNOPSIS
       #include <tk.h>

       Tk_Uid
       Tk_GetOption(tkwin, name, class)

ARGUMENTS
       Tk_Window tkwin (in)           Token for window.

       const char *name (in)          Name of desired option.

       const char *class (in)         Class  of  desired  option.   Null means
                                      there is no class for this  option;   do
                                      lookup based on name only.
______________________________________________________________________________

DESCRIPTION
       This procedure is invoked to retrieve an option from the database asso-
       ciated with tkwin's main window.  If there is an option for tkwin  that
       matches  the  given name or class, then it is returned in the form of a
       Tk_Uid.  If multiple options match name and class,  then  the  highest-
       priority one is returned.  If no option matches, then NULL is returned.

       Tk_GetOption  caches  options related to tkwin so that successive calls
       for the same tkwin will execute much more quickly than successive calls
       for different windows.

KEYWORDS
       class, name, option, retrieve



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | runtime/tk-8     |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source        was        downloaded        from         https://source-
       forge.net/projects/tcl/files/Tcl/8.6.7/tk8.6.7-src.tar.gz/download.

       Further information about this software can be found on the open source
       community website at https://www.tcl.tk/.



Tk                                                           Tk_GetOption(3tk)