Next: , Previous: Window Configurations, Up: Windows

28.20 Window Parameters

This sections describes how window parameters can be used to associate additional information with windows.

— Function: window-parameter window parameter

This function returns window's value for parameter. The default for window is the selected window. If window has no setting for parameter, this function returns nil.

— Function: window-parameters &optional window

This function returns all parameters of window and their values. The default for window is the selected window. The return value is an association list of elements of the form (parameter . value).

— Function: set-window-parameter window parameter value

This function sets window's value of parameter to value and returns value. The default for window is the selected window.

Currently, window parameters are not saved in window configurations and consequently not restored by set-window-configuration. Hence, any change of a parameter introduced via set-window-parameter can be undone only by invoking set-window-parameter for the same parameter again. Since save-window-excursion relies on window configurations (see Window Configurations), window parameters are not saved and restored by that special form, either.