Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄Function Group►  ◄Overview►                          ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_WINWINDOWMGR
 
HPS WinGetClipPS(hwnd, hwndClip, fs);
HWND hwnd;        /* address of the parent window */
HWND hwndClip;    /* handle of clipping type      */
USHORT fs;        /* clipping flags               */
 
The WinGetClipPS function returns a specially clipped, cached presentation
space for a specified window.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hwnd       Identifies the parent window.
 
hwndClip   Identifies the type of clipping to perform. This parameter can be
           one of the following values:
 
           Value        Meaning
           ─────────────────────────────────────────────────────────────────
           HWND_BOTTOM  Clip the last window in the sibling chain and
                        continue clipping until the next window is hwnd or
                        NULL.
 
           HWND_TOP     Clip the first window in the sibling chain and
                        continue clipping until the next window is hwnd or
                        NULL.
 
           NULL         Clip all siblings to the window identified by the
                        hwnd parameter.
 
fs         Specifies one or more clipping flags. This parameter can be one
           of the following values:
 
           Value                 Meaning
           ─────────────────────────────────────────────────────────────────
           PSF_CLIPCHILDREN      Clip out all child windows of hwnd. Same as
                                 PSF_CLIPWINDOWLIST and the hwndClip
                                 parameter equal to the first child window
                                 of hwnd.
 
           PSF_CLIPDOWNWARDS     Clip out all windows from hwndClip to the
                                 bottom-most sibling window of hwndClip.
 
           PSF_CLIPSIBLINGS      Clip out all sibling windows of hwnd. Same
                                 as PSF_CLIPWINDOWLIST and hwndClip equal to
                                 NULL.
 
           PSF_CLIPUPWARDS       Clip out all windows from the sibling
                                 windows directly in front of hwndClip to
                                 the front-most sibling window of hwndClip.
 
           PSF_LOCKWINDOWUPDATE  The presentation space returned is not
                                 locked from updating hwnd because of calls
                                 to WinLockWindowUpdate.
 
           PSF_PARENTCLIP        Obtain presentation space with a visible
                                 region for the parent window, but with
                                 window origin set to the origin of hwnd.
 
Return Value
 
The return value identifies a presentation space if the function is
successful, or it is NULL if an error occurs.
 
Comments
 
When your application finishes using the presentation space, the space
should be released by calling the WinReleasePS function.
 
See Also
 
WinGetPS, WinLockWindowUpdate, WinReleasePS
 
                                      ♦