PhClipboardCopy()

Copy data to the clipboard

Synopsis:

int PhClipboardCopy( unsigned short ig, 
                     int n,
                     PhClipHeader const clip[] );

Description:

This function copies data to the clipboard. Each input group has its own private clipboard, which can be selected 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.

Multiple representations of the data may be placed on the clipboard. The number of different types is specified with the n parameter. Each type has a header structure in the clip array. For more information, see PhClipHeader.

Returns:

0

Successful completion.

-1

An error occurred.

Classification:

Photon

See also:

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