WinSetClipbrdData - Parameters

hab (HAB) - input

Anchor-block handle.

ulh (ULONG) - input

General handle to the data object being set into the clipboard.

If NULLHANDLE, a WM_RENDERFMT message is sent to the clipboard-owner window to render the format when WinQueryClipbrdData is called with the specified format.

Once the data has been set into the clipboard, this handle can no longer be used by the application.

If CFI_POINTER is specified, this parameter contains a pointer to memory. The memory must have been allocated as unnamed and shareable, by DosAllocSharedMem with the OBJ_GIVEABLE attribute.

ulfmt (ULONG) - input

Clipboard format of the data object referenced by ulh.

The standard clipboard formats are shown in the following list. In addition to these predefined formats, any format value registered through the standard system atom manager displays this format in preference to privately-formatted data.

CF_TEXT

Text format. Each line ends with a carriage-return/line-feed combination. Tab characters separate fields within a line. A NULL character signals the end of the data.
CF_DSPTEXT
Text display format associated with private format.
CF_BITMAP
Bit map.
CF_DSPBITMAP
Bit-map display format associated with private format.
CF_METAFILE
Metafile.
CF_DSPMETAFILE
Metafile display format associated with private format.
CF_PALETTE
Palette.

flFmtInfo (ULONG) - input

Information.

Information about the type of data referenced by the ulh parameter.

Memory Model

One and only one of CFI_POINTER and CFI_HANDLE must be specified, unless CFI_OWNERDISPLAY is also specified.

CFI_POINTER

The ulh parameter is a flat pointer to the object.

When this memory model is specified, the system:

• saves the address (accessing it from the shell process), so that if the setting application terminates normally or abnormally, the data is still available. 
  frees the memory from the setting process, so that the setting application may no longer use it.
  CFI_POINTER must be specified if the ulfmt parameter is CF_TEXT or CF_DSPTEXT.
CFI_HANDLE
The ulh parameter is the handle to a metafile or bit map.

This must be specified if the ulfmt parameter is CF_BITMAP, CF_DSPBITMAP, CF_METAFILE or CF_DSPMETAFILE.

Usage Flags

CFI_OWNERFREE

Handle is not freed by WinEmptyClipbrd. The application must free the data if necessary.
CFI_OWNERDISPLAY
This flag indicates that the format is drawn by the clipboard owner in the clipboard viewer window by means of the WM_PAINTCLIPBOARD message. The ulh parameter should be NULL.
The values may be combined with bit-wise OR. Any number of the usage flags may be specified, but only one of the memory models.

rc (BOOL) - returns

Data-placed indicator.

Indicates whether data is placed into clipboard by this call:

TRUE

Data placed into clipboard.
FALSE
Data is not placed into clipboard, either an error occurred, or ulh is NULL.

---

[Back: WinSetClipbrdData Return Value - rc]
[Next: WinSetClipbrdData - Remarks]