PhClipboardPasteString()

Paste string-only data from the clipboard

Synopsis:

char *PhClipboardPasteString( unsigned short ig );

Description:

This function is a simple cover function for pasting string-only data from the clipboard. The function calls PhClipboardPasteStart(), requests data of type TEXT using PhClipboardPasteType(), and finishes with PhClipboardPasteFinish().

Each input group has its own private clipboard, which you can select through the ig parameter. 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.

This function allocates the resultant string with strdup(). Your application must free() this memory after use.

Returns:

A pointer to the text string extracted from the clipboard, or NULL if there was no available data or an error occurred.

Classification:

Photon

See also:

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

strdup(), free() in the QNX 4 C Library Reference