PhClipboardPasteStart()

Begin a paste operation

Synopsis:

void *PhClipboardPasteStart( unsigned short ig );

Description:

Call this function to begin a paste operation from the clipboard associated with the given input group ig. You can determine the current input group as follows:

• If you have the event that triggered the clipboard operation, use its input group (e.g. cbinfo->event->input_group) if it's nonzero.
• If that fails, get the value of the PHIG environment variable. If this value is nonzero, use it.
• If neither of the above if nonzero, specify an input group of 1.

The function allocates memory buffers to hold all clipboard data types, which are scanned to provide data to PhClipboardPasteType().

Returns:

A pointer to an internal structure describing the clipboard data, or NULL if an error occurred. The pointer must be passed to PhClipboardPasteType() and PhClipboardPasteFinish().

Classification:

Photon

See also:

PhClipboardCopy(), PhClipboardCopyString(), PhClipboardPasteFinish(), PhClipboardPasteString(), PhClipboardPasteType(), PhClipboardPasteTypeN(), PhClipHeader