WinSetClipbrdOwner: Difference between revisions
mNo edit summary |
No edit summary |
||
| Line 5: | Line 5: | ||
==Parameters== | ==Parameters== | ||
;hab (HAB) - input:Anchor-block handle. | ;''hab'' (HAB) - input:Anchor-block handle. | ||
;hwnd (HWND) - input:Window handle of the new clipboard owner. | ;''hwnd'' (HWND) - input:Window handle of the new clipboard owner. | ||
::NULLHANDLE: Clipboard-owner window is released and no new clipboard-owner window is established. | ::NULLHANDLE: Clipboard-owner window is released and no new clipboard-owner window is established. | ||
::Other: Window handle of the new clipboard owner. | ::Other: Window handle of the new clipboard owner. | ||
==Returns== | ==Returns== | ||
;rc (BOOL) - returns:Success indicator. | ;''rc'' (BOOL) - returns:Success indicator. | ||
::TRUE: Successful completion | ::TRUE: Successful completion | ||
::FALSE: Error occurred. | ::FALSE: Error occurred. | ||
==Errors== | ==Errors== | ||
Possible returns from WinGetLastError | Possible returns from [[WinGetLastError]] | ||
:PMERR_INVALID_HWND (0x1001) An invalid window handle was specified. | :PMERR_INVALID_HWND (0x1001) An invalid window handle was specified. | ||
==Remarks== | ==Remarks== | ||
The clipboard owner window receives the following clipboard-related messages at appropriate times: | The clipboard owner window receives the following clipboard-related messages at appropriate times: | ||
* WM_DESTROYCLIPBOARD | * [[WM_DESTROYCLIPBOARD]] | ||
* WM_HSCROLLCLIPBOARD | * [[WM_HSCROLLCLIPBOARD]] | ||
* WM_PAINTCLIPBOARD | * [[WM_PAINTCLIPBOARD]] | ||
* WM_RENDERALLFMTS | * [[WM_RENDERALLFMTS]] | ||
* WM_RENDERFMT | * [[WM_RENDERFMT]] | ||
* WM_SIZECLIPBOARD | * [[WM_SIZECLIPBOARD]] | ||
* WM_VSCROLLCLIPBOARD | * [[WM_VSCROLLCLIPBOARD]] | ||
==Example Code== | ==Example Code== | ||
| Line 35: | Line 35: | ||
#include <os2.h> | #include <os2.h> | ||
HAB hab; | HAB hab; /* anchor-block handle. */ | ||
HBITMAP bmap; | HBITMAP bmap; /* bit-map handle. */ | ||
HWND hwnd; | HWND hwnd; | ||
WinOpenClipbrd(hab); | WinOpenClipbrd(hab); | ||
WinSetClipbrdOwner(hab, | WinSetClipbrdOwner(hab, | ||
hwnd); /* window handle of the clipboard */ | |||
/* owner. */ | |||
WinSetClipbrdData(hab, | WinSetClipbrdData(hab, | ||
(ULONG)bmap, | |||
CF_BITMAP, | |||
CFI_HANDLE); /* tells the system that the */ | |||
/* bmap parameter is a handle */ | |||
/* to a bit map. */ | |||
WinCloseClipbrd(hab); | WinCloseClipbrd(hab); | ||
</pre> | </pre> | ||
==Related Functions== | ==Related Functions== | ||
*[[WinCloseClipbrd]] | * [[WinCloseClipbrd]] | ||
*[[WinEmptyClipbrd]] | * [[WinEmptyClipbrd]] | ||
*[[WinEnumClipbrdFmts]] | * [[WinEnumClipbrdFmts]] | ||
*[[WinOpenClipbrd]] | * [[WinOpenClipbrd]] | ||
*[[WinQueryClipbrdData]] | * [[WinQueryClipbrdData]] | ||
*[[WinQueryClipbrdFmtInfo]] | * [[WinQueryClipbrdFmtInfo]] | ||
*[[WinQueryClipbrdOwner]] | * [[WinQueryClipbrdOwner]] | ||
*[[WinQueryClipbrdViewer]] | * [[WinQueryClipbrdViewer]] | ||
*[[WinSetClipbrdData]] | * [[WinSetClipbrdData]] | ||
*[[WinSetClipbrdViewer]] | * [[WinSetClipbrdViewer]] | ||
[[Category:Win]] | [[Category:Win]] | ||
Latest revision as of 19:14, 10 April 2025
This function sets the current clipboard-owner window.
Syntax
WinSetClipbrdOwner( hab, hwnd )
Parameters
- hab (HAB) - input
- Anchor-block handle.
- hwnd (HWND) - input
- Window handle of the new clipboard owner.
- NULLHANDLE: Clipboard-owner window is released and no new clipboard-owner window is established.
- Other: Window handle of the new clipboard owner.
Returns
- rc (BOOL) - returns
- Success indicator.
- TRUE: Successful completion
- FALSE: Error occurred.
Errors
Possible returns from WinGetLastError
- PMERR_INVALID_HWND (0x1001) An invalid window handle was specified.
Remarks
The clipboard owner window receives the following clipboard-related messages at appropriate times:
- WM_DESTROYCLIPBOARD
- WM_HSCROLLCLIPBOARD
- WM_PAINTCLIPBOARD
- WM_RENDERALLFMTS
- WM_RENDERFMT
- WM_SIZECLIPBOARD
- WM_VSCROLLCLIPBOARD
Example Code
This example places a bit map into the clipboard.
#define INCL_WINCLIPBOARD
#include <os2.h>
HAB hab; /* anchor-block handle. */
HBITMAP bmap; /* bit-map handle. */
HWND hwnd;
WinOpenClipbrd(hab);
WinSetClipbrdOwner(hab,
hwnd); /* window handle of the clipboard */
/* owner. */
WinSetClipbrdData(hab,
(ULONG)bmap,
CF_BITMAP,
CFI_HANDLE); /* tells the system that the */
/* bmap parameter is a handle */
/* to a bit map. */
WinCloseClipbrd(hab);