MiniRobotLanguage (MRL)
CLB.Get Format Number
Returns the number from the clipboard format of the name in P1.
Intention
This command will return the number of the below listed 18 clipboard formats.
Example, if P1 = "CF_TIFF", the command will return 6.
Constant Name |
Value |
Comment |
|---|---|---|
CF_TEXT |
1 |
Text format |
CF_BITMAP |
2 |
Bitmap format |
CF_METAFILEPICT |
3 |
Metafile picture format |
CF_SYLK |
4 |
Microsoft Symbolic Link format |
CF_DIF |
5 |
Software Arts' Data Interchange Format |
CF_TIFF |
6 |
Tagged Image File Format |
CF_OEMTEXT |
7 |
Text format containing characters in the OEM character set |
CF_DIB |
8 |
Device Independent Bitmap |
CF_PALETTE |
9 |
Color palette format |
CF_PENDATA |
10 |
Pen data format |
CF_RIFF |
11 |
Resource Interchange File Format |
CF_WAVE |
12 |
Waveform audio format |
CF_UNICODETEXT |
13 |
Unicode text format |
CF_ENHMETAFILE |
14 |
Enhanced metafile format |
CF_HDROP |
15 |
Handle to a list of file names |
CF_LOCALE |
16 |
Locale identifier |
CF_DIBV5 |
17 |
Version 5 device independent bitmap (DIB) |
CF_MAX |
18 |
Maximum clipboard format value used in the enumeration |
Syntax
CLB.Get Format Number|P1[|P2]
Parameter Explanation
P1 - Name of the Clipboard Format to get the number for. Can be any Name as seen in the Table above.
P2 - (optional) Variable for the result, if omitted, result goes to TOS.
Example
'***********************************
' CLB.-Sample
'***********************************
CLB.Get Format Name|6|$$RET
PRT.$$RET
CLB.Get Format Value|CF_Bitmap|$$RET
PRT.$$RET
MBX.!
ENR.
Remarks
-
Limitations:
-
See also:
•