Caution: This version of this document is no longer maintained. For the latest documentation, see http://www.qnx.com/developers/docs.

PhClipboardCopyString()

Copy string-only data to the clipboard

Synopsis:

int PhClipboardCopyString( unsigned short ig,
                           const char *string );

Library:

ph

Description:

This function is a simple cover function for copying string-only data to the clipboard. It builds a PhClipboardHdr entry:

{ "TEXT", strlen(string), string }

and then calls PhClipboardWrite() to perform the operation. The string must be NULL terminated.

Each input group has its own private clipboard, which can be selected through the ig parameter. To determine the current input group, call PhInputGroup(), passing to it the event that triggered the clipboard operation (e.g. cbinfo->event).

Returns:

0
Successful completion.
-1
An error occurred.

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PhClipboardHdr, PhClipboardPasteString(), PhClipboardRead(), PhClipboardWrite()