formZ SDK | 5.0 API Reference | Project | Window Manager

fz_wind_get_active

Description

Gets the project window index of the active window. This is the front most project window and the one where all graphic input occurs

IMPORTANT NOTE!

THIS FUNCTION SHOULD NEVER BE USED IN PLACE OF A PROJECT WINDOW INDEX PARAMETER (windex) PROVIDED TO A CALL BACK FUNCTION. ALWAYS USE THE PROVIDED PROJECT WINDOW INDEX AS FORMZ FREQUENTLY WILL PROCESS WINDOWS OTHER THAN THE ACTIVE WINDOW. THIS FUNCTION SHOULD ONLY BE USED FOR MANAGING WINDOWS SUCH AS CASES WHERE IT IS DESIRABLE TO SAVE OFF THE CURRENT WINDEX AND THEN RESTORE IT AFTER SOME WINDOW MANIPULATIONS.

Plugin Prototype

fzrt_error_td fz_wind_get_active(

fzrt_int *

windex )

Parameters

windex [Result]

project window index

Returns

Error codes

Availability

5.0.0.0

Example Files

util_wind.fsl

Function Set

fz_wind_fset


Defined in

fz_wind_api.h