[ Home | Alpha index | Topic index | Tutorials | Download | Feedback ]

The OS/2 API Project

WinInitialize

[ Syntax | Params | Returns | Include | Usage | Structs | Gotchas | Code | Also ]

Syntax

hab = WinInitialize( flOptions );

Parameters

ULONG flOptions (input)
The only allowed value is 0L.

Returns

HAB hab
This return value is a handle to an anchor block. The anchor block is a structure which is used by OS/2 to keep track of application specific error information, and the handle is needed for certain other PM functions, such as WinCreateMsgQueue. NULLHANDLE is returned if an error occurred.

Include Info

#define INCL_WINWINDOWMGR
or
#define INCL_WIN
or
#define INCL_PM
#include <os2.h>

Usage Explanation

This function must be the first PM function called by any application thread intending to use PM or GPI services. The return value is sometimes needed by other functions and should be saved. WinTerminate can be called if a thread no longer needs these services. This API can only be called once per thread.

Relevant Structures

Gotchas

Sample Code

HAB hab; ULONG flOptions = 0L; HMQ hmq; hab=WinInitialize(flOptions); hmq=WinCreateMsgQueue(hab, 0L);

See Also

WinCreateMsgQueue, WinGetLastError, WinGetErrorInfo, WinQueryAnchorBlock, WinTerminate

Author

Carsten Whimster - bcrwhims@uwaterloo.ca

Additions

Last modified March 7/1996
Please send all errors, comments, and suggestions to: timur@vnet.ibm.com

The OS/2 API Project

WinInitialize