PAI and PrintAllInformation (Record subroutines)

From m204wiki
Revision as of 19:00, 11 July 2014 by JAL (talk | contribs) (Created page with "{{Template:Record:PAI and PrintAllInformation subtitle}} <var>PrintAllInformation</var> is a synonym for the <var>PAI</var> subroutine. ==Syntax== {{Template:String:PAI synt...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Print All Information from record (Record class)


PrintAllInformation is a synonym for the PAI subroutine.

Syntax

Template:String:PAI syntax Template:String:PrintAllInformation syntax

Syntax terms

%outString A string variable to receive the result of the Center / Centre method.
string The string to which the method is applied.
length The number of characters desired in the output %string. If this value is greater than the length of the method object string, the method object string is padded on both the right and left to the requested length. If the method object is shorter than length, it is cropped on both the left and right.
Pad This is an optional, name required, parameter that defines the character used to pad string on the right and left (if the length value is greater than the length of string). If an uneven number of pad characters is required, the location of the extra pad character is determined by the value of the OffsetLeft parameter. The default for c is a blank character (' '). Specifying an explicit null ('') results in no padding.
OffsetLeft An optional, name-required, argument that is a Boolean enumeration value indicating where to put the extra character if the requested padding or cropping is asymmetric. If the required number of pad characters or characters to be cropped is not even, the default (False) is to produce an extra character on the right.