Difference between revisions of "PrintInteger"

Latest revision as of 21:16, 2 March 2010

Prints an integer to the log file.

void PrintInteger(
    int nInteger,
    int bPrepend = FALSE
);

Parameters:

nInteger: The integer value to print out to the log
bPrepend: Specifies if the type of value should be prepended on to the log string

Prints the integer nInteger to the log file. If bPrepend is TRUE, then 'PRINTINTEGER' will be prepended onto the text outputted to the log file.

@@ Line 1: / Line 1: @@
-This is a test - the real page will follow!
+{{dafunction
-[[Category:Scripts]]
+|name=PrintInteger
+|brief=Prints an integer to the log file.
+|param1type=int
+|param1name=nInteger
+|param1desc=The integer value to print out to the log
+|param1default=
+|param2type=int
+|param2name=bPrepend
+|param2desc=Specifies if the type of value should be prepended on to the log string
+|param2default=FALSE
+|returntype=void
+|returndesc=
+|sourcefile=script.ldf
+|sourcemodule=
+}}
+== Description ==
+<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
+Prints the integer nInteger to the log file. If bPrepend is TRUE, then 'PRINTINTEGER'
+will be prepended onto the text outputted to the log file.
+<!-- == Remarks == -->
+<!-- This section contains additional comments, observations and known issues. -->
+<!-- == Examples == -->
+<!-- This section contains examples transcluded from the snippet library. -->
+== See also ==
+<!-- This section contains links to articles, functions or constant groups. -->
+[[PrintFloat]], [[PrintString]], [[PrintObject]], [[PrintVector]], [[PrintToLog]]
+[[Category: Print & log functions]]