Core Function Printf

Revision as of 06:47, 10 November 2011

SPrintf( <expression>, <expressions>... )

Description

Create a formatted string.

expression

The format string and flags to use (see Remarks).

expressions

Variables that will be output according to the "Format Control".

Return Value

Success: Returns the formatted string.

Failure: Returns an empty string.

Format Control

Something to note is that params are counted from 0 for example

Printf("format string", "param0", "param1", "param2", "param3")

And so on so to use param0 in the foramt string

"foramt {0}"

To use param 1

"foramt {1}"

To use param 0 and 3

"foramt {0} {3}"

Now after you enter the param number you can a place a : then special formats as shown below for example to print a hex number

Printf("{0:x4}\n", (int)1337)

See its using param 0 then : which means we want a special format then x to say we want to use a hex format then 4 to say we want the hex to be 4 chars long.

Strings

There really isn’t any formatting within a string, beyond it’s alignment. Alignment works for any argument being printed.

Example:

Printf("->{0,10}<-\n", "Hello")
Printf("->{0,-10}<-\n", "Hello")
; Generates
; ->     Hello<-
; ->Hello     <-

Numbers

Basic number formatting specifiers:

Custom number formatting:

The group separator is especially useful for formatting currency values which require that negative values be enclosed in parentheses. This currency formatting example at the bottom of this document makes it obvious:

Dates

Note that date formatting is especially dependant on the system’s regional settings; the example strings here are from my local locale.

The ‘U’ specifier seems broken; that string certainly isn’t sortable.

Custom date formatting:

In the examples below a @DateTimeNow was used.

Enumerations

Some Examples

Remarks

Warning: If you expect to use int, byte, float etc in the params then you must cast it as such for example:

$myint = 100
$val = SPrintf("Value is 0x'{0:x}'", (int)$myint) ; The (int) will only take in $myint
 
$myint = 100
$myint2 = 100
$val = SPrintf("Value is 0x'{0:x}'", (int)($myint + $myint2)) ; The (int) will now take in $myint AND $myint2

Note how $myint was cast as an int? using (int)$myint this is vital since if you dont do that it might send a string or a float you never really know with $variables so its best to cast it.

There is an alternative method example:

$myint = 100
$val = SPrintf("Value is 0x'{0:x}'", int($myint))

Its up to you to decide which one to use.

If you wish to capture the output of Printf to create strings:

Go see SPrintf( <expression>, <expressions>... ) to Printf to strings.

Anything thats valid for Printf to print to console window is also valid for SPrintf to use to create strings.

Example

Printf("Value is 0x'{0:x}'", (int)100) ; Prints 0x64 since the {0:x} is telling it to place param 0 as :x meaning hex