Differences

This shows you the differences between two versions of the page.

--- gl_excel:linedescription [2010/06/21 16:36 UTC] – created mwolfe
+++ gl_excel:linedescription [2023/07/24 14:33 UTC] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== LineDescription ======
-This function returns the full description of a user report line based on the user report name and line code.
+This function returns the full description of a user report line based on the user report name and line code.  If no line code is provided, the function returns the full description of the user report itself.
-%InlineCode{LineDescription(UserRpt, LineCode)}%
+**LineDescription(UserRpt, //LineCode//)**
 ==== Example Usage ====
-  * %InlineCode{=LineDescription("BALCON", "A01")}%  Returns the description for line A01 of the BALCON user report.
+  * **=LineDescription("BALCON")**  Returns the full report description for the BALCON user report.
+  * **=LineDescription("BALCON", "A01")**  Returns the description for line A01 of the BALCON user report.
 ==== Required Parameters ====
 {{section>parameters#userrpt}}
+==== Optional Parameters ====
 {{section>parameters#linecode}}