. DirectXtras Home
        Home

DirectCommunication Xtra
DirectConnection Xtra
DirectControl Xtra
DirectEmail Xtra
DirectFTP Xtra
DirectImage Xtra
DirectInteraction Xtra
DirectOS Xtra
Documentation
License Agreement
Licensing Fees
Order Form
DirectSMS Xtra
DirectSound Xtra
DirectTransition Xtra
DirectTransition3D Xtra Set I
DirectTransition3D Xtra Set II
DirectTransition3D Xtra Set III
DirectTTS Xtra
XtrAgent
DirectXport Xtra

SpeechPlugin

Special Discounted Bundles

The Gallery
How To Order
Order Form
Check for Upgrades

Sign in
Change Your Profile

Contact Us
















    .
DirectXtras
Xtra Power for Director & Authorware



DirectOS Xtra
 Directing Windows and MacOS. The OS at your fingertips!

Authorware 4.x Compatible Authorware 5.x CompatibleAuthorware 6.x CompatibleAuthorware 7.x CompatibleDirector 5.x Compatible Director 6.x CompatibleDirector 7.x Compatible Director 8.x CompatibleDirector MX Compatible     MacOS 8.x and 9.x CompatibleMacOS X CompatibleWindows Compatible   

dosSetWindowState(integer WindowID, string State)

Sets the state of the specified window.

Parameters :

WindowID : An integer specifying the window ID. This should be a value returned from one of the window ID retrieval methods. On Windows, this should be a window that may change its state. If a window ID representing a window that may not change state (such as a control) is passed, the resulting action and error code may be unpredictable.
State : A string specifying the state to set the specified window to. This parameter is case insensitive.
Possible Values for Windows and MacOS :
"Normal" : Sets the window to a normal state (visible, not maximized, minimized or hidden) and activates it.
"Maximized" : Sets the window to a maximized state and activates it. On MacOS, this is equivalent to "Normal".
"Minimized" : Sets the window to a minimized state. If the window is activated, the next next top-level window in the z-order will become the active window.
"Restored" : Restores the window to its original size and position and activates the window. On MacOS, this is equivalent to "Normal".
"Restored Inactive" : Restores the window to its most recent size and position without activating the window.
"Minimized Active" : Activates the window and displays it as a minimized window. On MacOS, this is equivalent to "Minimized".
"Minimized Inactive" :
Displays the window as a minimized window without activating the window. On MacOS, this is equivalent to "Minimized".
"Minimized Forced" :
Minimizes a window, even if the application that owns the window is hung. On MacOS, this is equivalent to "Minimized". On Windows, this feature is only available in Windows 2000 and later.

Possible Values for Windows Only :
"Hidden" : Sets the window to a hidden state with no visible graphical user interface components.
"Always On Top" :
Places the specified window above all other windows. The window will stay on top of all other windows whose state is not set to always on top.
"Not Always On Top" :
Allows other windows to move on top of the specified window.
"Activated" : Activates the window and displays it in its current size and position.
"Inactivated" : Displays the window in its current size and position. This value is similar to "Activated", except the window is not activated.

Return Value : An integer indicating whether the method was successful or not. If 1 is returned, the method was successful. If 0 is returned, the method was not successful in which case dosGetLastError() should be called to determine the cause of the error. 

Possible Returned Error Codes via dosGetLastError() :
10002 : Invalid value for parameter 2.
10029 : Bad window ID.

Remarks  : This function is not available on MacOS X.



DirectXtras Inc.
P.O Box 2645, Menlo Park, CA, 94026, U.S.A
Voice: +1-415-5058249, Fax: +1-801-8585841
Toll Free: 1-800-4453093
E-mail General Information: info@directxtras.com
E-mail Technical Support: support@directxtras.com

Copyright 1996-2004 DirectXtras Inc. All Rights Reserved.
WebMaster: tamar@directxtras.com
Last Updated: 6/7/2004 6:36:41 AM.