WinBeginPaint: Difference between revisions

Latest revision as of 18:32, 14 May 2025

This function is called (normally in a WM_PAINT message) to obtain presentation space for drawing in a specified window.

Syntax

hps = WinBeginPaint( hwnd, hps, prcl )

Parameters

HWND hwnd (input): A window handle to where the drawing is going to occur.
HPS hps (input): A handle to presentation space.
PRECTL prcl (input): A pointer to the bounding rectangle. The value must be in the range of -32,767 through 32,767. A NULL value indicates no bounding rectangle (the whole window will be painted).

Returns

HPS hps: Handle to the newly created presentation space. NULLHANDLE is returned if there was an error. WinGetLastError will return one of:

0x1001	PMERR_INVALID_HWND
0x207F	PMERR_INV_HPS

Include Info

#define INCL_WINWINDOWMGR
#include <os2.h>

Sample Code

#define INCL_WINWINDOWMGR
#include 
   .
   .
   .
case WM_PAINT:
    hps = WinBeginPaint(hwnd, NULLHANDLE, NULL);

    WinQueryWindowRect(hwnd, &rcl);

    WinDrawText(hps, -1, "Hello World", &rcl, CLR_NEUTRAL, CLR_BACKGROUND,
                DT_CENTER | DT_VCENTER | DT_ERASERECT);

    WinEndPaint(hps);
    return 0;
   .
   .
   .

@@ Line 1: / Line 1: @@
-=== Syntax ===
+This function is called (normally in a WM_PAINT message) to obtain presentation space for drawing in a specified window.
-  hps = WinBeginPaint( ''hwnd'',
+==Syntax==
-                      ''hps'',
+  hps = WinBeginPaint( ''hwnd'', ''hps'', ''prcl'' )
-                      ''prcl'' );
-=== Parameters ===
-HWND ''hwnd'' (input)
-A window handle to where the drawing is going to occur.
-HPS ''hps'' (input)
-A handle to presentation space.
-PRECTL ''prcl'' (input)
-A pointer to the bounding rectangle. The value must be in the
-range of -32,767 through 32,767. A NULL value indicates no bounding
-rectangle (the whole window will be painted).
+== Parameters ==
+;HWND ''hwnd'' (input):A window handle to where the drawing is going to occur.
+;HPS ''hps'' (input):A handle to presentation space.
+;PRECTL ''prcl'' (input):A pointer to the bounding rectangle. The value must be in the range of -32,767 through 32,767. A NULL value indicates no bounding rectangle (the whole window will be painted).
-=== Returns ===
+== Returns ==
-  HPS hps
+;HPS hps:Handle to the newly created presentation space. NULLHANDLE is returned if there was an error. WinGetLastError will return one of:
+{|class="wikitable"
-Handle to the newly created presentation space.  NULLHANDLE is returned if there was an error. WinGetLastError will return one of:
-{| border="1"
-|-
 |0x1001
 |PMERR_INVALID_HWND
@@ Line 34: / Line 17: @@
 |0x207F
 |PMERR_INV_HPS
 |}
-=== Include Info ===
+== Include Info ==
   #define INCL_WINWINDOWMGR
-  #include &lt;os2.h&gt;
+  #include <os2.h>
-=== Usage Explanation ===
+==Sample Code==
+<pre>
-This function is called (normally in a WM_PAINT message) to obtain
-presentation space for drawing in a specified window.
-=== Relevant Structures ===
-=== Gotchas ===
-=== Sample Code ===
-<pre>
 #define INCL_WINWINDOWMGR
 #include
     .
     .
@@ Line 73: / Line 44: @@
     .
 </pre>
-=== See Also ===
-[[OS2 API:PMI:WinEndPaint|WinEndPaint]],
-[[OS2 API:PMI:WinExcludeUpdateRegion|WinExcludeUpdateRegion]],
-[[OS2 API:PMI:WinGetClipPS|WinGetClipPS]],
-[[OS2 API:PMI:WinGetPS|WinGetPS]],
-[[OS2 API:PMI:WinGetScreenPS|WinGetScreenPS]],
-[[OS2 API:PMI:WinInvalidateRect|WinInvalidateRect]],
-[[OS2 API:PMI:WinInvalidateRegion|WinInvalidateRegion]],
-[[OS2 API:PMI:WinIsWindowShowing|WinIsWindowShowing]],
-[[OS2 API:PMI:WinIsWindowVisible|WinIsWindowVisible]],
-[[OS2 API:PMI:WinLockVisRegions|WinLockVisRegions]],
-[[OS2 API:PMI:WinOpenWindowDC|WinOpenWindowDC]],
-[[OS2 API:PMI:WinQueryUpdateRect|WinQueryUpdateRect]],
-[[OS2 API:PMI:WinQueryUpdateRegion|WinQueryUpdateRegion]],
-[[OS2 API:PMI:WinRealizePalette|WinRealizePalette]],
-[[OS2 API:PMI:WinReleasePS|WinReleasePS]],
-[[OS2 API:PMI:WinShowWindow|WinShowWindow]],
-[[OS2 API:PMI:WinUpdateWindow|WinUpdateWindow]],
-[[OS2 API:PMI:WinValidateRect|WinValidateRect]],
-[[OS2 API:PMI:WinValidateRegion|WinValidateRegion]]
-[[Category:The OS/2 API Project]]
+==See Also==
+* [[WinEndPaint]]
+* [[WinExcludeUpdateRegion]]
+* [[WinGetClipPS]]
+* [[WinGetPS]]
+* [[WinGetScreenPS]]
+* [[WinInvalidateRect]]
+* [[WinInvalidateRegion]]
+* [[WinIsWindowShowing]]
+* [[WinIsWindowVisible]]
+* [[WinLockVisRegions]]
+* [[WinOpenWindowDC]]
+* [[WinQueryUpdateRect]]
+* [[WinQueryUpdateRegion]]
+* [[WinRealizePalette]]
+* [[WinReleasePS]]
+* [[WinShowWindow]]
+* [[WinUpdateWindow]]
+* [[WinValidateRect]]
+* [[WinValidateRegion]]
+[[Category:Win]]