Skip to content

Latest commit

 

History

History
108 lines (72 loc) · 4.49 KB

nf-winuser-setclipboardviewer.md

File metadata and controls

108 lines (72 loc) · 4.49 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name req.apiset
NF:winuser.SetClipboardViewer
SetClipboardViewer function (winuser.h)
Adds the specified window to the chain of clipboard viewers. Clipboard viewer windows receive a WM_DRAWCLIPBOARD message whenever the content of the clipboard changes. This function is used for backward compatibility with earlier versions of Windows.
SetClipboardViewer
SetClipboardViewer function [Data Exchange]
_win32_SetClipboardViewer
_win32_setclipboardviewer_cpp
dataxchg.setclipboardviewer
winui._win32_setclipboardviewer
winuser/SetClipboardViewer
dataxchg\setclipboardviewer.htm
dataxchg
VS|winui|~\winui\windowsuserinterface\dataexchange\clipboard\clipboardreference\clipboardfunctions\setclipboardviewer.htm
12/05/2018
SetClipboardViewer, SetClipboardViewer function [Data Exchange], _win32_SetClipboardViewer, _win32_setclipboardviewer_cpp, dataxchg.setclipboardviewer, winui._win32_setclipboardviewer, winuser/SetClipboardViewer
winuser.h
Windows.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
User32.lib
User32.dll
Windows
19H1
SetClipboardViewer
winuser/SetClipboardViewer
c++
APIRef
kbSyntax
DllExport
User32.dll
Ext-MS-Win-NTUser-Misc-L1-5-1.dll
SetClipboardViewer
ext-ms-win-ntuser-misc-l1-5-1 (introduced in Windows 10, version 10.0.14393)

SetClipboardViewer function

-description

Adds the specified window to the chain of clipboard viewers. Clipboard viewer windows receive a WM_DRAWCLIPBOARD message whenever the content of the clipboard changes. This function is used for backward compatibility with earlier versions of Windows.

-parameters

-param hWndNewViewer [in]

Type: HWND

A handle to the window to be added to the clipboard chain.

-returns

Type: HWND

If the function succeeds, the return value identifies the next window in the clipboard viewer chain. If an error occurs or there are no other windows in the clipboard viewer chain, the return value is NULL. To get extended error information, call GetLastError.

-remarks

The windows that are part of the clipboard viewer chain, called clipboard viewer windows, must process the clipboard messages WM_CHANGECBCHAIN and WM_DRAWCLIPBOARD. Each clipboard viewer window calls the SendMessage function to pass these messages to the next window in the clipboard viewer chain.

A clipboard viewer window must eventually remove itself from the clipboard viewer chain by calling the ChangeClipboardChain function — for example, in response to the WM_DESTROY message.

The SetClipboardViewer function exists to provide backward compatibility with earlier versions of Windows. The clipboard viewer chain can be broken by an application that fails to handle the clipboard chain messages properly. New applications should use more robust techniques such as the clipboard sequence number or the registration of a clipboard format listener. For further details on these alternatives techniques, see Monitoring Clipboard Contents.

Examples

For an example, see Adding a Window to the Clipboard Viewer Chain.

-see-also

ChangeClipboardChain

Clipboard

Conceptual

GetClipboardViewer

Reference

SendMessage