Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄Function Group►  ◄Overview►  ◄Message Group►         ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_WINCLIPBOARD
 
ULONG WinQueryClipbrdData(hab, fmt)
HAB hab;       /* handle of the anchor block       */
USHORT fmt;    /* specifies the format of the data */
 
The WinQueryClipbrdData function obtains a handle to the current clipboard
data having a specified format.
 
The returned data handle cannot be used after the WinCloseClipbrd function
is called. For this reason, the application must either copy the data, if
required for long-term use, or process the data before WinCloseClipbrd is
called.
 
The application should not free the data handle itself nor leave it locked
in any way.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hab        Identifies an anchor block.
 
fmt        Specifies the format of the data that is accessed by this
           function. For a list of formats, see the
           ◄Standard clipboard formats► topic.
 
Return Value
 
The return value is a handle to the data in the clipboard in the format
specified by the fmt parameter. If the format does not exist or if an error
occurred, the return value is NULL.
 
See Also
 
WinCloseClipbrd, WinOpenClipbrd, WinSetClipbrdData
 
                                      ♦