GetClipboardParameter Method

Description

Returns an chosen clipboard format and content parameter information.

Return Type

A Boolean value. A Boolean with value True (-1) when successful.
Failure Returns False.

Failure conditions:
* Value Not chosen.
* vContentParm Not supported for given lClipFormat.
* GetClipboardParameter Not supported.
* Implementation defined.

Syntax

object.GetClipboardParameter (sDisplayName, pOverridden, hwndParent, plClipFormat, pvContentParm, psDescription, [valClipFormatFilter])

The GetClipboardParameter Method syntax has these parts:

Part	Description
object	An expression evaluating to an object of type McDataHandler.
sDisplayName	Required. A String value.
pOverridden	Required. An IUnknown object.
hwndParent	Required. A Long value. The window handle of the parent window to be when a configuration windows is displayed.
plClipFormat	Required. A Long value.
pvContentParm	Required. A Variant value.
psDescription	Required. A String value.
valClipFormatFilter	Optional. A Variant value. A VT_I4(Long) or a (VT_ARRAY + VT_I4) specifying the clipboard formats requested by the caller. A VT_Empty (default) may be used to signify no filter criteria.

Remarks

When a handler supports multiple versions of content for a single clipboard format, this function may be used to prompt the user for the specific content. Besides returning an identifier describing the content, the localized content name is also returned. lClipFormat is also returned since multiple content parameters may be supported for multiple clipboard formats. A McDataHandler does Not support enumeration of vContent just lClipboardFormats. The function is the only method to manage or choose the content parameter. The vContentParm and vContentParm values are used in the 'ClipboardData' functions (NodeClipboardData, ObjectClipboardData, FileClipboardData) to identify content and format. Assume a McDataHandler that supported the following clipboard combinations: lClipFormat vContentParm sDescription ----------- ---------- CF_TEXT "Annotations" "Text Annotation" CF_TEXT "DataPath" "Data property file path" CF_ENHMETAFILE "Image" "Image" CF_ENHMETAFILE "ImageEnh" "Image Enhanced" CF_ENHMETAFILE "Annotations" "Image Annotations" CF_DIB "Image" "Image" CF_DIB "ImageEnh" "Image Enhanced" CF_TIFF "Image" "Image" CF_TIFF "ImageEnh" "Image Enhanced" CF_ImagePro.Doc "Image" "Image" CF_ImagePro.Doc "ImageEnh" "Image Enhanced" When successful this function would return the values in a row chosen either programmatically or by user intervention. The chosen combination could be stored as a configuration and be re-used at a later time. When a non-zero lClipFormat is passed to the function only vContentParms of the given clipboard format should be considered.