Jump to content

ULSPutUnicodeClipboard: Difference between revisions

From EDM2
Created page with "==Description== Places Unicode text onto the clipboard. This function converts the specified string into Unicode (UCS-2) and then places it into the clipboard in the "text/un..."
 
No edit summary
Line 41: Line 41:
==Returns==
==Returns==
       N/A
       N/A
[[Category:The OS/2 API Project]]

Revision as of 14:58, 16 June 2016

Description

Places Unicode text onto the clipboard.

This function converts the specified string into Unicode (UCS-2) and then places it into the clipboard in the "text/unicode" format. (This format is used by Mozilla and some other applications directly; it is also supported by recent versions of the UClip library, as used by OpenOffice.org 2.x.) Note that the text is NOT copied in plain text format as well; if the application desires this done, it must do so itself (by whatever means it has available).

NOTE: This function does not clear the clipboard of other formats either. That, too, is up to the application to do if it is deemed necessary.

Arguments

ULSPutUnicodeClipboard( string [, sourcecp] [, controls] [, path] )

Parameters:

     string    The string to be placed on the clipboard (required).
     sourcecp  The source codepage (a positive integer).  This is the codepage
               with which <string> is encoded (i.e. under which it would
               display correctly).  The default is the current process
               codepage.
     controls  The control-byte mapping flag.  This specifies how to convert
               those byte values which can represent either control codes or
               glyphs depending on the context: specifically, 0x00-0x19 and
               0x7F.  Only the first character is significant, and (if
               specified) must be one of the following values:
                 D  data/control bytes: leave values unchanged; this is the
                    default
                 G  displayable glyphs: convert according to codepage like
                    any other character
                 C  control bytes: convert using standard IBM control mapping
                 L  treat linebreaks (CR and LF) as control bytes, but all
                    others as displayable glyphs
     path      The path conversion flag.  This only applies to DBCS codepages,
               and indicates whether or not <string> should be assumed to
               contain a path specification.  Only the first character is
               significant, and (if specified) must be one of the following
               values:
                 Y  yes, assume string contains a path; this is the default
                 N  no, assume string doesn't contain a path

Returns

     N/A