WinSetClipbrdViewer: Difference between revisions

Latest revision as of 19:15, 10 April 2025

This function sets the current clipboard-viewer window to a specified window.

Syntax

WinSetClipbrdViewer( hab, hwndNewClipViewer )

Parameters

hab (HAB) - input

Anchor-block handle.

hwndNewClipViewer (HWND) - input

Window handle of the new clipboard viewer.

NULLHANDLE: The clipboard-viewer window is released and no new clipboard-viewer window is established.

Other: Window handle of the new clipboard viewer.

Returns

rc (BOOL) - returns

Success indicator.

TRUE: Valid, new clipboard-viewer window established

FALSE: There is no new clipboard-viewer window established.

Errors

Possible returns from WinGetLastError

PMERR_INVALID_HWND (0x1001) An invalid window handle was specified.

Remarks

The clipboard-viewer window receives the WM_DRAWCLIPBOARD message when the contents of the clipboard change. This allows the viewer window to display an up-to-date version of the clipboard contents.

The clipboard must be open before this function is invoked.

Example Code

This example shows how a window views the clipboard contents.

#define INCL_WINCLIPBOARD
#include <os2.h>

ULONG   hclipbrdData;
HAB     hab;         /* anchor-block handle. */
HBITMAP bmap;        /* bit-map handle.     */
HWND    hwnd;

WinOpenClipbrd(hab);
WinSetClipbrdViewer(hab,
                  hwnd); /* window handle of the clipboard */
                        /* viewer.                         */
hclipbrdData = WinQueryClipbrdData(hab,
                                   CF_TEXT);
WinCloseClipbrd(hab);

Related Messages

WM_DRAWCLIPBOARD

Related Functions

@@ Line 1: / Line 1: @@
 This function sets the current clipboard-viewer window to a specified window.
 ==Syntax==
   WinSetClipbrdViewer( ''hab'', ''hwndNewClipViewer'' )
 ==Parameters==
-;hab (HAB) - input
+;''hab'' (HAB) - input:Anchor-block handle.
-:Anchor-block handle.
+;''hwndNewClipViewer'' (HWND) - input:Window handle of the new clipboard viewer.
+::NULLHANDLE: The clipboard-viewer window is released and no new clipboard-viewer window is established.
-;hwndNewClipViewer (HWND) - input
+::Other: Window handle of the new clipboard viewer.
-:Window handle of the new clipboard viewer.
-:;NULLHANDLE
-::The clipboard-viewer window is released and no new clipboard-viewer window is established.
-:;Other
-::Window handle of the new clipboard viewer.
 ==Returns==
-;rc (BOOL) - returns
+;''rc'' (BOOL) - returns:Success indicator.
-:Success indicator.
+::TRUE: Valid, new clipboard-viewer window established
-:;TRUE
+::FALSE: There is no new clipboard-viewer window established.
-::Valid, new clipboard-viewer window established
-:;FALSE
-::There is no new clipboard-viewer window established.
 ==Errors==
-Possible returns from WinGetLastError
+Possible returns from [[WinGetLastError]]
-:;PMERR_INVALID_HWND (0x1001)
+:PMERR_INVALID_HWND (0x1001) An invalid window handle was specified.
-::An invalid window handle was specified.
 ==Remarks==
-The clipboard-viewer window receives the WM_DRAWCLIPBOARD message when the contents of the clipboard change. This allows the viewer window to display an up-to-date version of the clipboard contents.
+The clipboard-viewer window receives the [[WM_DRAWCLIPBOARD]] message when the contents of the clipboard change. This allows the viewer window to display an up-to-date version of the clipboard contents.
 The clipboard must be open before this function is invoked.
 ==Example Code==
-Definition:
+This example shows how a window views the clipboard contents.
 <pre>
-#define INCL_WINCLIPBOARD /* Or use INCL_WIN, INCL_PM, */
+#define INCL_WINCLIPBOARD
 #include <os2.h>
-HAB     hab;                /*  Anchor-block handle. */
+ULONG   hclipbrdData;
-HWND    hwndNewClipViewer;  /*  Window handle of the new clipboard viewer. */
+HAB     hab;         /* anchor-block handle. */
-BOOL    rc;                 /*  Success indicator. */
+HBITMAP bmap;        /* bit-map handle.     */
+HWND    hwnd;
-rc = WinSetClipbrdViewer(hab, hwndNewClipViewer);
-</pre>
-This example shows how a window views the clipboard contents.
-<pre>
-#define INCL_WINCLIPBOARD
-#include <OS2.H>
-ULONG hclipbrdData;
-HAB hab;                 /* anchor-block handle. */
-HBITMAP bmap;            /* bit-map handle.      */
-HWND hwnd;
 WinOpenClipbrd(hab);
 WinSetClipbrdViewer(hab,
-                   hwnd); /* window handle of the clipboard */
+                  hwnd); /* window handle of the clipboard */
-                          /* viewer.                        */
+                        /* viewer.                         */
 hclipbrdData = WinQueryClipbrdData(hab,
                                     CF_TEXT);
 WinCloseClipbrd(hab);
+</pre>
-</pre>
+== Related Messages==
+* [[WM_DRAWCLIPBOARD]]
 ==Related Functions==
-*[[WinCloseClipbrd]]
+* [[WinCloseClipbrd]]
-*[[WinEmptyClipbrd]]
+* [[WinEmptyClipbrd]]
-*[[WinEnumClipbrdFmts]]
+* [[WinEnumClipbrdFmts]]
-*[[WinOpenClipbrd]]
+* [[WinOpenClipbrd]]
-*[[WinQueryClipbrdData]]
+* [[WinQueryClipbrdData]]
-*[[WinQueryClipbrdFmtInfo]]
+* [[WinQueryClipbrdFmtInfo]]
-*[[WinQueryClipbrdOwner]]
+* [[WinQueryClipbrdOwner]]
-*[[WinQueryClipbrdViewer]]
+* [[WinQueryClipbrdViewer]]
-*[[WinSetClipbrdData]]
+* [[WinSetClipbrdData]]
-*[[WinSetClipbrdOwner]]
+* [[WinSetClipbrdOwner]]
-== Related Messages==
-* WM_DRAWCLIPBOARD
 [[Category:Win]]