This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

Tk_GetOption(3)                             Tk Library Procedures                            Tk_GetOption(3)



____________________________________________________________________________________________________________

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 associated with tkwin's  main  win-dow. window.
       dow.   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



Tk                                                                                           Tk_GetOption(3)