Syntax 2 For blobs

Description

Converts data in a blob to a string value. If the blob’s
value is not text data, String attempts to interpret
the data as characters.

Syntax

<span>String</span> ( <span>blob</span> {,<span>encoding</span>} )

1	<span>String</span> ( <span>blob</span> {,<span>encoding</span>} )

Argument	Description
blob	The blob whose value you want returned as a string. Blob can also be an Any variable containing a blob.
encoding	Character encoding of the blob you want converted. Values are: EncodingANSI! EncodingUTF8! EncodingUTF16LE! (default) EncodingUTF16BE!

Argument

Description

blob

The blob whose value you want returned
as a string. Blob can also be an Any variable
containing a blob.

encoding

Character encoding of the blob you want
converted. Values are:

EncodingANSI!
EncodingUTF8!
EncodingUTF16LE! (default)
EncodingUTF16BE!

Return Values

String. Returns the value of blob as
a string if it succeeds and the empty string (“”) if it fails. It
the blob does not contain string data, String interprets
the data as characters, if possible, and returns a string. If blob is null, String returns null.

Usage

If the encoding argument is not provided, String converts
a Unicode blob to a Unicode string. You must provide the encoding argument
if the blob has a different encoding.

If the blob has a byte-order mark (BOM), String filters
it out automatically. For example, suppose the blob’s hexadecimal
display is: FF FE 54 00 68 00 69 00 73 00.
The BOM is FF FE, which indicates that the blob has UTF-16LE encoding,
and is filtered out. The string returned is “This”.

You can also use String to extract a string
from the Message object after calling TriggerEvent or PostEvent.
For more information, see the TriggerEvent or PostEvent functions.

Examples

This example converts the blob instance variable ib_sblob,
which contains string data in ANSI format, to a string and stores
the result in sstr:

string sstr

1	string sstr

sstr = <span>String</span>(ib_sblob, EncodingANSI!)

1	sstr = <span>String</span>(ib_sblob, EncodingANSI!)

This example stores today’s date and test
status information in the blob bb. Pos1 and pos2 store
the beginning and end of the status text in the blob. Finally, BlobMid extracts
a “sub-blob” that String converts to a string. Sle_status displays
the returned status text:

blob{100} bb

1	blob{100} bb

long pos1, pos2

1	long pos1, pos2

string test_status

1	string test_status

date test_date

1	date test_date

test_date = Today()

1	test_date = Today()

IF DayName(test_date) = "Wednesday" THEN &amp;

1	IF DayName(test_date) = "Wednesday" THEN &

   test_status = "Coolant Test"

1	test_status = "Coolant Test"

IF DayName(test_date) = "Thursday" THEN &amp;

1	IF DayName(test_date) = "Thursday" THEN &

   test_status = "Emissions Test"

1	test_status = "Emissions Test"

// Store data in the blob

1	// Store data in the blob

pos1 = BlobEdit( bb, 1, test_date)

1	pos1 = BlobEdit( bb, 1, test_date)

pos2 = BlobEdit( bb, pos1, test_status )

1	pos2 = BlobEdit( bb, pos1, test_status )

... // Some processing

1	... // Some processing

// Extract the status stored in bb and display it

1	// Extract the status stored in bb and display it

sle_status.text = <span>String</span>( &amp;

1	sle_status.text = <span>String</span>( &

   BlobMid(bb, pos1, pos2 - pos1))

1	BlobMid(bb, pos1, pos2 - pos1))

Connection Information

Syntax 2 For blobs – PB Docs 126