View source for WinSetClipbrdViewer

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.
<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 */
                        /* viewer.                         */
hclipbrdData = WinQueryClipbrdData(hab,
                                   CF_TEXT);
WinCloseClipbrd(hab);
</pre>

== Related Messages==
* [[WM_DRAWCLIPBOARD]]

==Related Functions==
* [[WinCloseClipbrd]]
* [[WinEmptyClipbrd]]
* [[WinEnumClipbrdFmts]]
* [[WinOpenClipbrd]]
* [[WinQueryClipbrdData]]
* [[WinQueryClipbrdFmtInfo]]
* [[WinQueryClipbrdOwner]]
* [[WinQueryClipbrdViewer]]
* [[WinSetClipbrdData]]
* [[WinSetClipbrdOwner]]

[[Category:Win]]