GetOption(3)

GetOption3

Retrieve an option from the option database

Usage

#include <tk.h>

Tk_Uid
Tk_GetOption(tkwin, name, class)

Arguments

Token for window. Name of desired option. Class of desired option. Null means there is no class for this option; do lookup based on name only.

Overview

This procedure is invoked to retrieve an option from the database associated 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

Releases

109 releases since Mac OS X 10.4; the text changed 1 time.

  1. 10.4–10.4.2
  2. 10.6–26.5

From tcl 152 in macOS 26.5. Parsed by carta from the page's man source.