HideFloatingWindows

Hides an application's floating windows.



 
pascal OSStatus HideFloatingWindows (void);

function result: A result code; see Result Codes. Returns errFloatingWindowsNotInitialized (-5609) if you have not called InitFloatingWindows prior to HideFloatingWindows ; otherwise, returns noErr (0).

DISCUSSION

When your application receives a suspend event, it must hide any visible floating windows. When your application receives a resume event, it must make its floating windows visible again. See Responding to Suspend and Resume Events for an example of how your application can call the HideFloatingWindows function.

SPECIAL CONSIDERATIONS

You must call the function InitFloatingWindows prior to calling HideFloatingWindows .

The HideFloatingWindows function operates only upon windows created with the kFloatingWindowClass constant; see Window Class Constants for more details on this constant.

VERSION NOTES

Supported with Mac OS 8.6 and later.