beautypg.com

Teledyne LeCroy Protocol Analyzers File-Based Decoding User Manual User Manual

Page 40

background image

Chapter 11: Primitives

File-based Decoding User Manual

34

LeCroy Corporation

Format()

Format (string>, string or integer>)

Parameter

Meaning

Default

Value

Comments

format string

value string or integer

Support
Supported by all LeCroy analyzers.

Return value
None.

Comments
Format
is used to control the way that arguments print out. The format string may contain

conversion specifications that affect the way in which the arguments in the value string
are returned. Format conversion characters, flag characters, and field width modifiers are
used to define the conversion specifications.

Example

Format("0x%02X", 20);

would yield the string 0x14.
Format can only handle one value at a time, so

Format("%d %d", 20, 30);

would not work properly. Furthermore, types that do not match what is specified in the
format string yields unpredictable results.