lotus-domino-designer programming guide vol1

Lotus Domino Designer

Version7

Programming Guide, Volume 1: Overview and Formula Language

G210-2370-00

Note: Before using this information and the product it supports, read the information in "Notices" at the end of this document.

First Edition (December, 2005) This edition applies to IBM Lotus Domino Designer 7 (product number L-GHUS-5RWNHM), and to all subsequent releases and modifications, until otherwise indicated in new editions. Copyright International Business Machines Corporation 1994, 2005. All rights reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

ContentsChapter 1. Programming Overview . . . 1Programming in IBM Lotus Domino Designer . Where to use scripts and formulas . . . . . Table of programmable design elements . . . Toolbars . . . . . . . . . . . . . . To create a new toolbar button . . . . . Examples: Toolbars . . . . . . . . . Replication formulas . . . . . . . . . . Examples: Replication formulas . . . . . Agents . . . . . . . . . . . . . . Examples: Agents . . . . . . . . . . Actions . . . . . . . . . . . . . . Examples: Actions . . . . . . . . . Hotspots . . . . . . . . . . . . . . Examples: Hotspots. . . . . . . . . Form, selection, and column formulas . . . Form formulas . . . . . . . . . . Selection formulas . . . . . . . . . Column formulas . . . . . . . . . Window title, section access, and insert subform formulas . . . . . . . . . . . . . Window title formulas . . . . . . . . Section access formulas . . . . . . . Insert subform formulas . . . . . . . Section title and hidden paragraph formulas . Section title formulas . . . . . . . . Hidden paragraph formulas . . . . . . Hidden column and row custom color formulas Hidden column formulas . . . . . . . Row custom color formulas . . . . . . Named element formulas . . . . . . . . To enter a named element formula: . . . Examples: Named element formulas . . . Image formulas . . . . . . . . . . . Examples: Image formulas . . . . . . Events . . . . . . . . . . . . . . Examples: Events . . . . . . . . . Field design formulas . . . . . . . . . Default value formulas . . . . . . . Input translation formulas . . . . . . Input validation formulas . . . . . . Input enabled formulas . . . . . . . HTML attributes formulas . . . . . . Value formulas for computed fields . . . Keyword field formulas . . . . . . . Event descriptions . . . . . . . . . . LotusScript subroutines and functions . . LotusScript Declarations and Options areas . Current document in onLoad and PostOpen Compatibility issues . . . . . . . . Forward compatibility . . . . . . . . Backwards compatibility . . . . . . . onHelp and HelpRequest . . . . . . . Event sequencing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 . 1 . 2 . 3 . 4 . 4 . 5 . 5 . 5 . 6 . 7 . 8 . 9 . 10 . 11 . 11 . 12 . 12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 13 14 14 14 14 15 15 15 15 15 15 16 16 16 17 17 19 19 19 19 20 20 20 20 21 31 31 31 31 33 33 33 33

Chapter 2. User Interface . . . . . . . 37Accessing the Programmers pane . . . . . . Exploring the Programmers pane . . . . . . Exploring the Java interface in the Programmers pane . . . . . . . . . . . . . . . . Using the Info List . . . . . . . . . . . Adjusting the size of the Info List . . . . . Using the Objects tab . . . . . . . . . . Programming an objects properties and events Using the Reference tab . . . . . . . . . Pasting information from the Reference tab into the Script area . . . . . . . . . . . Using shortcut keys to access the Reference tab Using the Errors box . . . . . . . . . . Using the Script area . . . . . . . . . . Setting Script area properties . . . . . . Setting text properties . . . . . . . . . Setting format properties . . . . . . . . Moving the insertion point while editing text in the Script area . . . . . . . . . . . Selecting text . . . . . . . . . . . . Editing text with key combinations . . . . Editing text with menu commands . . . . Saving and deleting text in the Script area . . Renaming an object, subprogram, or class . . Automatically completing statements . . . . Writing Java in an agent . . . . . . . . . Viewing output from a Java agent . . . . . Adding resource, class, or archive files to an agent . . . . . . . . . . . . . . Including a script library on the class path . . Compiling Java . . . . . . . . . . . Exporting Java . . . . . . . . . . . Importing Java . . . . . . . . . . . Writing JavaScript in the Programmers pane . . To program an object event in JavaScript . . Writing JavaScript in a page header . . . . Compiling JavaScript . . . . . . . . . Importing and exporting JavaScript . . . . Writing LotusScript in the Programmers pane . . Defining global variables and subprograms . . Creating an additional script in LotusScript. . Completing a LotusScript block statement automatically . . . . . . . . . . . . Completing a LotusScript %directive automatically . . . . . . . . . . . . Compiling LotusScript . . . . . . . . . Importing and exporting LotusScript . . . . Exploring the LotusScript Debugger . . . . . Using the LotusScript Debugger . . . . . Selecting a subprogram . . . . . . . . Stepping through a script . . . . . . . . Debugging with breakpoints . . . . . . . Using the debugger utilities . . . . . . . Using the Remote Debugger . . . . . . . . To enable remote debugging on the server . . . 37 . 37 . . . . 39 40 40 40 41 . 41

. 42 42 . 42 . 42 . 43 . 43 . 43 . . . . . . . . . . . . . . . . . . . . . . 43 44 44 44 45 45 45 47 48 48 48 48 48 49 49 49 50 50 50 50 51 51

. 52 . . . . . . . . . . . 52 52 52 53 54 54 55 55 56 57 57

iii

To enable remote debugging in the agent . . . To start the Remote Debugger . . . . . . . To debug a scheduled LotusScript agent remotely Debugging Java code remotely . . . . . . . . To enable Java debugging on a Notes client . . To enable Java debugging in an agent, Web service, or script library . . . . . . . . . To connect a debugger to the JVM . . . . . . Security considerations . . . . . . . . . Using Script Libraries . . . . . . . . . . . To create a script library . . . . . . . . . To access an existing script library . . . . . . Incorporating a LotusScript script library . . . Incorporating a Java script library . . . . . . Incorporating a Javascript script library . . . . Recompiling all LotusScript . . . . . . . . . To recompile all the LotusScript code in a database . . . . . . . . . . . . . . Writing formulas in the Programmers pane . . . To enter a formula in the Programmers pane . . Using the formula window . . . . . . . . Using the Programmers pane for Simple action(s)

58 58 58 59 60 60 60 61 61 61 62 62 62 63 63 64 64 64 65 65

Chapter 3. Programming Domino for Web Applications . . . . . . . . . . 67Formula language . . . . . . . . . Where formulas work on the Web . . . @Functions on the Web . . . . . . @Commands on the Web . . . . . . Web agents . . . . . . . . . . . Setting up a Web agent . . . . . . Activating a Web agent . . . . . . LotusScript and Java in Web agents . . Examples: Web agents . . . . . . . JavaScript . . . . . . . . . . . . JavaScript events . . . . . . . . JavaScript in HTML . . . . . . . JavaScript object model . . . . . . Domino objects . . . . . . . . . Web services . . . . . . . . . . . Web services terminology. . . . . . Web services in Domino Designer . . . Web services on a Domino server . . . Java and LotusScript mappings . . . . Examples: Web services . . . . . . Examples: Web services data descriptions Server configuration for Web browsers . . The browser.cnf file . . . . . . . Language cross-reference . . . . . Dynamic HTML sections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 . 67 . 68 . 71 . 79 . 79 . 79 . 80 . 80 . 82 . 83 . 84 . 86 . 90 . 91 . 91 . 92 . 95 . 95 . 103 . 107 . 111 . 111 . 111 . 111

Numeric constants . . . . . . . . . Time-date constants . . . . . . . . Using operators . . . . . . . . . . Operators and precedence . . . . . . Order of evaluation for operations . . . Assignment operator . . . . . . . . List subscript operator . . . . . . . List concatenation operator . . . . . . Unary operators . . . . . . . . . Arithmetic operators . . . . . . . . Text operator . . . . . . . . . . Comparison operators . . . . . . . Logical operators . . . . . . . . . Operations on lists . . . . . . . . Using @functions . . . . . . . . . . Syntax . . . . . . . . . . . . . Return values . . . . . . . . . . Side-effects . . . . . . . . . . . @Commands . . . . . . . . . . Order of evaluation for formula statements Using reserved words . . . . . . . . Examples: Using keywords . . . . . . Specifying form and view names in formulas . Debugging formulas . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . .

118 118 120 120 121 121 122 123 123 123 123 123 123 124 126 126 126 127 127 128 129 129 130 130

Chapter 5. Formula Language Coding Guidelines. . . . . . . . . . . . . 133Formulas . . . . . . . . . . . . . . . Writing formulas that evaluate to a result . . . Writing formulas that perform actions . . . . Working with lists . . . . . . . . . . . Using conditional statements . . . . . . . Using iterative statements . . . . . . . . Writing messages and getting user input . . . . Writing messages to the user . . . . . . . Getting user input with @Prompt and @PickList Filling out a form with @DialogBox . . . . . Getting and setting environment variables . . . Handling errors . . . . . . . . . . . . Syntax errors . . . . . . . . . . . . Run-time errors . . . . . . . . . . . Working with @functions . . . . . . . . . Working with @commands . . . . . . . . . Performing string operations . . . . . . . . Converting data types . . . . . . . . . Concatenating, comparing, and determining length . . . . . . . . . . . . . . . Locating and extracting substrings . . . . . Trimming, repeating, adding a new line, and changing case . . . . . . . . . . . . Performing arithmetic operations . . . . . . . Examples: Performing arithmetic operations . . Performing time-date operations . . . . . . . Examples: Performing time-date operations . . Accessing the user environment . . . . . . . Examples: Accessing the user environment . . Accessing the current database and view . . . . Database and view attributes . . . . . . . Window title and column formula @functions Examples: Accessing the current database and view . . . . . . . . . . . . . . . 133 133 134 135 138 139 140 140 141 143 143 144 144 144 146 147 148 148 149 151 153 154 155 156 158 158 159 160 160 160 161

Chapter 4. Formula Language RulesUsing the syntax rules Lexical elements . General syntax rules Using variables . . . Fields . . . . . Temporary variables Using constants. . . Text constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

113. . . . . . . . 113 113 114 114 114 116 117 117

iv

Prgramming Guide, Volume 1: Overview and Formula Language

Accessing the current document in the formula language . . . . . . . . . . . . . . . Examples: Accessing the current document . . Accessing data outside the current document and database . . . . . . . . . . . . . . . Examples: Accessing data outside the current document and database . . . . . . . . . Accessing external databases through LS:DO using @functions . . . . . . . . . . . . . . Examples: Accessing external databases through LS:DO using @functions . . . . . . . . .

161 163 164 165 166 166

Chapter 6. Formula Language @Functions A-Z . . . . . . . . . . 167Where does this @function work? (Part 1 A -- D) Where does this @function work? (Part 1 E -- K) Where does this @function work? (Part 1 L -- R) Where does this @function work? (Part 1 S -- Z) Where does this @function work? (Part 2 A -- D) Where does this @function work? (Part 2 E -- K) Where does this @function work? (Part 2 L -- R) Where does this @function work? (Part 2 S -- Z) @Functions with ECL security . . . . . . . @Abs . . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @Abs . . . . . . . . . . @Abstract . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Keywords . . . . . . . . . . . . Rules . . . . . . . . . . . . . . Files . . . . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @Abstract . . . . . . . . . @Accessed . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Usage in workflow applications . . . . . Usage in column or selection formulas . . . Language cross-reference . . . . . . . Examples: @Accessed . . . . . . . . . @ACos . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @ACos . . . . . . . . . . @AddToFolder . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @AddToFolder . . . . . . . @Adjust . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . 167 170 174 177 181 184 188 191 195 196 196 196 196 196 196 197 197 197 197 198 198 200 201 203 203 203 203 203 204 204 204 204 204 204 204 205 205 205 205 205 205 205 205 205 206 206 206

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Calculating due dates . . . . . . . . Language cross-reference . . . . . . . Examples: @Adjust . . . . . . . . . @AdminECLIsLocked . . . . . . . . . Syntax . . . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . @All . . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Examples: @All . . . . . . . . . . . @AllChildren . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . @AllDescendants . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Examples: @AllChildren and @AllDescendants @Ascii . . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Examples: @Ascii . . . . . . . . . . @ASin . . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @ASin . . . . . . . . . . @ATan. . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @ATan . . . . . . . . . . @ATan2 . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @ATan2 . . . . . . . . . @AttachmentLengths . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @AttachmentLengths . . . . . @AttachmentModifiedTimes . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Examples: @AttachmentModifiedTimes . . . @AttachmentNames . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

206 207 207 207 207 207 208 208 208 208 208 208 208 208 209 209 209 209 209 209 209 209 209 210 211 211 211 211 211 212 212 212 212 212 212 212 212 212 212 213 213 213 213 213 213 213 214 214 214 214 214 214 214 215 215 215 215 215 215 216 216

Contents

v

Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Language cross-reference . . . Examples: @AttachmentNames . @Attachments . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage in a Column Formula . . Examples: @Attachments . . . @Author . . . . . . . . . . Syntax . . . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @Author . . . . . @Begins . . . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Examples: @Begins . . . . . @BrowserInfo . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @BrowserInfo . . . @BusinessDays . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Examples: @BusinessDays . . . @Certificate . . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @Certificate . . . . @Char . . . . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @Char . . . . . . @CheckAlarms . . . . . . . . Syntax . . . . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . @CheckFormulaSyntax . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Examples: @CheckFormulaSyntax @ClientType . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

216 216 216 216 217 217 217 217 217 217 217 217 217 217 218 218 218 218 218 218 219 219 219 219 219 219 219 220 220 220 221 221 221 221 221 221 222 222 222 223 223 223 223 223 223 223 224 224 224 224 225 225 225 225 225 225 225 225 226 226 226

Syntax . . . . . . . Return value . . . . Usage . . . . . . . Examples: @ClientType . @Command . . . . . . Syntax . . . . . . . Usage . . . . . . . Exceptions . . . . . @Compare . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Usage . . . . . . . Language cross-reference Examples: @Compare. . @ConfigFile . . . . . . Syntax . . . . . . . Return value . . . . Usage . . . . . . . Examples: @ConfigFile . @Contains . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Usage . . . . . . . Language cross-reference Examples: @Contains . . @Cos . . . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Language cross-reference Examples: @Cos . . . @Count . . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Language cross-reference Examples: @Count. . . @Created . . . . . . . Syntax . . . . . . . Return value . . . . Usage . . . . . . . Language cross-reference Examples: @Created . . @Date . . . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Language cross-reference Examples: @Date . . . @Day . . . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Language cross-reference Examples: @Day . . . @DB2Schema . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

226 226 226 226 227 227 227 227 228 228 228 228 228 229 229 230 230 230 230 230 230 230 230 230 231 231 231 231 231 231 231 232 232 232 232 232 232 232 232 233 233 233 233 233 233 234 234 234 234 235 235 235 235 235 235 235 235 236 236 236 236

vi


Usage . . . . . . . . . . . . . . . Examples: @Day . . . . . . . . . . . @DbColumn (Domino data source) . . . . . . Syntax . . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . . Return value . . . . . . . . . . . . Specifying the server and database . . . . . Notes . . . . . . . . . . . . . . . Specifying a view or folder . . . . . . . . Specifying the column number . . . . . . Accessing the return values . . . . . . . Usage . . . . . . . . . . . . . . . Server agents and security . . . . . . . . Other agents and security . . . . . . . . Language cross-reference . . . . . . . . Examples: @DbColumn (Domino data source) @DbColumn (ODBC data source) . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . . Return value . . . . . . . . . . . . Specifying the data source . . . . . . . . Specifying IDs and passwords . . . . . . . Specifying the table name . . . . . . . . Specifying null handling. . . . . . . . . Specifying Distinct . . . . . . . . . . Specifying sort . . . . . . . . . . . . Usage . . . . . . . . . . . . . . . Language cross-reference . . . . . . . . Examples: @DbColumn (ODBC data source) . . @DbCommand (Domino data source) . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . . Usage . . . . . . . . . . . . . . . Examples: @DbCommand (Domino data source) @DbCommand (ODBC data source) . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . . Return value . . . . . . . . . . . . Specifying the data source . . . . . . . . Specifying IDs and passwords . . . . . . . Specifying the command string . . . . . . Specifying null handling. . . . . . . . . Accessing values found . . . . . . . . . Usage . . . . . . . . . . . . . . . Examples: @DbCommand (ODBC data source) @DbExists . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . . Return value . . . . . . . . . . . . Usage . . . . . . . . . . . . . . . Language cross-reference . . . . . . . . Examples: @DbExists . . . . . . . . . . @DbLookup (Domino data source) . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . . Return value . . . . . . . . . . . . Specifying the server and database . . . . . Notes . . . . . . . . . . . . . . . Specifying a view . . . . . . . . . . . Specifying a key . . . . . . . . . . . Specifying a field name . . . . . . . . .

236 237 237 237 237 238 238 238 238 239 239 239 239 240 240 240 240 240 240 242 242 242 242 243 243 243 244 244 244 245 245 245 245 246 246 247 247 247 248 248 248 248 249 249 250 250 250 250 250 250 250 251 251 251 251 252 252 253 253 253 254

Specifying the column number . . . . . Accessing the return values . . . . . . Usage . . . . . . . . . . . . . . Server agents and security . . . . . . . Other agents and security . . . . . . . Examples: @DbLookup (Domino data source) @DbLookup (ODBC data source) . . . . . . Syntax . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Specifying the data source . . . . . . . Specifying IDs and passwords . . . . . . Specifying the table name . . . . . . . Specifying null handling. . . . . . . . Specifying key_column and key . . . . . Specifying Distinct . . . . . . . . . Specifying sort . . . . . . . . . . . Accessing the values found . . . . . . . Usage . . . . . . . . . . . . . . Examples: @DbLookup (ODBC data source) . @DbManager . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Return value . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @DbManager . . . . . . . . @DbName . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @DbName . . . . . . . . . @DbTitle . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Return value . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @DbTitle . . . . . . . . . @DDEExecute . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Examples: @DDEExecute . . . . . . . @DDEInitiate . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Initiation failures . . . . . . . . . . @DDEPoke . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Usage . . . . . . . . . . . . . . @DDETerminate . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . DEFAULT . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . .Contents

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

254 255 255 255 255 255 256 256 256 258 258 258 258 258 259 259 260 260 260 260 261 261 261 261 261 262 262 262 262 262 263 263 263 263 263 263 264 264 264 264 264 265 265 266 266 266 266 266 267 267 267 267 267 267 267 268 268 268 268 268 268

vii

Examples:DEFAULT . . . @DeleteDocument . . . . . Syntax . . . . . . . . Usage . . . . . . . . Language cross-reference . Examples: @DeleteDocument @DeleteField . . . . . . Syntax . . . . . . . Usage . . . . . . . . Language cross-reference . Examples: @DeleteField . . @DialogBox . . . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Sharing of field values . . Language cross-reference . Examples: @DialogBox . . @Do . . . . . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Examples: @Do . . . . . @DocChildren . . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @DocChildren . @DocDescendants . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @DocDescendants @DocFields . . . . . . . Syntax . . . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @DocFields . . @DocLength . . . . . . . Syntax . . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @DocLength . . @DocLevel . . . . . . . Syntax . . . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @DocLevel . . @DocLock . . . . . . . Syntax . . . . . . . . Parameters . . . . . . Usage . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

268 269 269 269 269 269 269 269 269 270 270 270 270 270 271 272 272 272 272 273 273 273 273 273 273 273 274 274 274 274 274 274 275 275 275 275 276 276 276 276 276 276 276 277 277 277 277 277 277 278 278 278 278 278 278 278 278 279 279 279 279

Language cross-reference . . Examples: @DocLock . . . . @DocMark . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Usage . . . . . . . . . Language cross-reference . . @DocNumber . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @DocNumber . . @DocOmittedLength . . . . . Syntax . . . . . . . . . Return value . . . . . . Usage . . . . . . . . . Examples: @DocOmittedLength @DocParentNumber . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @DocParentNumber @DocSiblings . . . . . . . Syntax . . . . . . . . . Return value . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @DocSiblings . . . @DocumentUniqueID . . . . Syntax . . . . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @DocumentUniqueID @Domain . . . . . . . . . Syntax . . . . . . . . . Return value . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @Domain . . . . @DoWhile . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @DoWhile . . . . @EditECL . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @EditECL . . . . @EditUserECL . . . . . . . Syntax . . . . . . . . . Usage . . . . . . . . . Language cross-reference . . @Elements . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

279 280 280 280 280 280 280 281 281 281 281 281 281 281 282 282 282 282 282 282 282 283 283 283 283 283 283 283 283 284 284 284 284 284 284 285 285 285 285 286 286 286 286 286 286 286 286 287 287 287 287 287 287 287 287 288 288 288 288 288 288

viii


Syntax . . . . . . . Parameters . . . . . Return value . . . . Usage . . . . . . . Examples: @Elements . . @EnableAlarms . . . . . Syntax . . . . . . . Usage . . . . . . . Language cross-reference @Ends . . . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Examples: @Ends . . . ENVIRONMENT . . . . Syntax . . . . . . . Usage . . . . . . . Language cross-reference @Environment . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Usage . . . . . . . Language cross-reference Examples: @Environment, and ENVIRONMENT . @Error. . . . . . . . Syntax . . . . . . . Return value . . . . Usage . . . . . . . Language cross-reference Examples: @Error . . . @Eval . . . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Usage . . . . . . . Language cross-reference Examples: @Eval . . . @Exp . . . . . . . . Syntax . . . . . . . Parameters . . . . . Usage . . . . . . . Language cross-reference Examples: @Exp . . . @Explode. . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Language cross-reference Examples: @Explode . . @Failure . . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Usage . . . . . . . Language cross-reference Examples: @Failure . . @False . . . . . . . . Syntax . . . . . . Return value . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . @SetEnvironment, . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

288 288 288 288 288 289 289 289 289 289 289 289 290 290 290 290 290 290 290 291 291 291 291 291 292 293 293 293 293 293 293 294 294 294 294 294 294 294 295 295 295 295 295 295 295 295 295 296 296 296 297 297 297 297 297 297 297 297 298 298

Usage . . . . . . . . . . Language cross-reference . . . Examples: @False . . . . . . FIELD . . . . . . . . . . . Syntax . . . . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: FIELD . . . . . . @FileDir . . . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Examples: @FileDir . . . . . @FloatEq . . . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Examples: @FloatEq . . . . . @FontList. . . . . . . . . . Syntax . . . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Examples: @FontList . . . . . @For . . . . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @For . . . . . . @FormLanguage . . . . . . . Syntax . . . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @FormLanguage. . . @GetAddressBooks . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Examples: @GetAddressBooks . . @GetCurrentTimeZone . . . . . Syntax . . . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Examples: @GetCurrentTimeZone @GetDocField . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @GetDocField . . . @GetField . . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

298 298 298 298 298 298 298 299 299 299 299 299 299 299 300 300 300 300 300 300 300 300 301 301 301 301 301 301 302 302 302 302 303 303 303 303 303 303 303 303 303 303 304 304 304 304 304 304 304 304 304 304 305 305 305 305 305 305 306 306 306 306

Contents

ix

Examples: @GetField . . . @GetFocusTable . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Examples: @GetFocusTable . @GetHTTPHeader . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @GetHTTPHeader @GetIMContactListGroupNames Syntax . . . . . . . . Return value . . . . . Usage . . . . . . . . @GetPortsList . . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Examples: @GetPortsList . @GetProfileField . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @GetProfileField . @GetViewInfo . . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Examples: @GetViewInfo . @HardDeleteDocument . . . Syntax . . . . . . . . Usage . . . . . . . . Language cross-reference . @HashPassword . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . @Hour . . . . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Language cross-reference . Examples: @Hour . . . . @If . . . . . . . . . . Syntax . . . . . . . . Parameters . . . . . . Usage . . . . . . . . Language cross-reference . Examples: @If . . . . . @IfError . . . . . . . . Syntax . . . . . . . . Parameters . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

306 306 306 306 307 307 307 307 307 307 308 308 308 308 308 308 308 309 309 309 309 309 309 309 309 309 310 310 310 310 310 311 311 311 311 311 312 312 312 312 312 312 313 313 313 313 313 313 313 313 313 313 314 314 314 314 314 314 315 315 315

Return value . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @IfError . . . . @Implode . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Language cross-reference . . Examples: @Implode . . . . @InheritedDocumentUniqueID . Syntax . . . . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @InheritedUniqueID @Integer . . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @Integer . . . . @IsAgentEnabled . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @IsAgentEnabled . @IsAppInstalled . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . @IsAvailable . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @IsAvailable . . . @IsCategory . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Examples: @IsCategory . . . @IsDB2 . . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Examples: @IsDB2 . . . . . @IsDocBeingEdited . . . . . Syntax . . . . . . . . . Return value . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @IsDocBeingEdited . @IsDocBeingLoaded . . . . . Syntax . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

315 316 316 316 316 316 316 317 317 317 317 317 317 317 318 318 318 318 318 318 318 319 319 319 319 319 319 319 319 320 320 320 320 320 320 320 320 320 320 321 321 321 321 321 321 322 322 322 322 322 322 323 323 323 323 323 323 324 324 324 324

x


Return value . . . . . . . . Usage . . . . . . . . . . . Examples: @IsDocBeingLoaded . . @IsDocBeingMailed . . . . . . . Syntax . . . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Examples: @IsDocBeingMailed . . @IsDocBeingRecalculated . . . . . Syntax . . . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Examples: @IsDocBeingRecalculated . @IsDocBeingSaved . . . . . . . Syntax . . . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Examples: @IsDocBeingSaved . . . @IsDocTruncated . . . . . . . . Syntax . . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: @IsDocTruncated . . . @IsEmbeddedInsideWCT . . . . . Syntax . . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: @IsEmbeddedInsideWCT . @IsError . . . . . . . . . . . Syntax . . . . . . . . . . . Parameters . . . . . . . . . Return value . . . . . . . . Language cross-reference . . . . Examples: @IsError . . . . . . @IsExpandable . . . . . . . . . Syntax . . . . . . . . . . . Parameters . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Examples: @IsExpandable . . . . @IsMember . . . . . . . . . . Syntax . . . . . . . . . . . Parameters . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: @IsMember . . . . . @IsModalHelp . . . . . . . . . Syntax . . . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . @IsNewDoc . . . . . . . . . . Syntax . . . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: @IsNewDoc . . . . . @IsNotMember . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

324 324 324 324 324 325 325 325 325 325 325 325 326 326 326 326 326 326 326 327 327 327 327 327 327 327 327 328 328 328 328 328 328 328 328 328 329 329 329 329 329 330 330 330 330 330 330 331 331 331 331 331 331 331 331 331 331 332 332 332 332

Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Examples: @IsNotMember . . . @IsNull . . . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Examples: @IsNull. . . . . . @IsNumber . . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @IsNumber . . . . @IsResponseDoc . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @IsResponseDoc . . . @IsText . . . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Language cross-reference . . . Examples: @IsText . . . . . . @IsTime . . . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Language cross-reference . . . Examples: @IsTime . . . . . @IsUnavailable . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @IsUnavailable . . . @IsValid . . . . . . . . . . Syntax . . . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @IsValid . . . . . @IsVirtualizedDirectory . . . . . Syntax . . . . . . . . . . Return value . . . . . . . Examples: @IsVirtualizedDirectory @Keywords . . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Examples: @Keywords . . . . @LanguagePreference . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

332 332 333 333 333 333 333 333 334 334 334 334 334 334 334 334 334 335 335 335 335 335 335 335 335 336 336 336 336 336 336 336 336 336 337 337 337 337 337 337 337 337 337 337 338 338 338 338 338 338 338 338 338 339 339 339 339 340 340 341 341

Contents

xi

Return value . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @LanguagePreference @LaunchApp . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Usage . . . . . . . . . Language cross-reference . . @LDAPServer . . . . . . . Syntax . . . . . . . . . Examples: @LDAPServer . . @Left . . . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Language cross-reference . . Examples: @Left . . . . . @LeftBack . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Language cross-reference . . Examples: @LeftBack . . . . @Length . . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Language cross-reference . . Examples: @Length . . . . @Like . . . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Language cross-reference . . Examples: @Like . . . . . @Ln . . . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @Ln . . . . . . @Locale . . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Supported language codes . . Language cross-reference . . Examples: @Locale . . . . @Log . . . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Examples: @Log . . . . . @LowerCase. . . . . . . . Syntax . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Language cross-reference . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

341 341 341 341 342 342 342 342 342 342 342 342 342 343 343 343 343 343 343 343 343 344 344 344 344 344 344 344 345 345 345 345 345 345 345 346 346 346 346 346 346 346 346 346 347 347 347 350 350 351 351 351 351 351 351 352 352 352 352 352 352

Examples: @LowerCase . . . . . . @MailDbName . . . . . . . . . . Syntax . . . . . . . . . . . . Return value . . . . . . . . . Usage . . . . . . . . . . . . Language cross-reference . . . . . Examples: @MailDbName . . . . . @MailEncryptSavedPreference . . . . . Syntax . . . . . . . . . . . . Return value . . . . . . . . . Usage . . . . . . . . . . . . Examples: @MailEncryptSavedPreference @MailEncryptSentPreference . . . . . Syntax . . . . . . . . . . . . Return value . . . . . . . . . Usage . . . . . . . . . . . . Language cross-reference . . . . . Examples: @MailEncryptSentPreference . @MailSavePreference . . . . . . . . Syntax . . . . . . . . . . . . Return value . . . . . . . . . Usage . . . . . . . . . . . . Language cross-reference . . . . . Examples: @MailSavePreference . . . @MailSend . . . . . . . . . . . Syntax . . . . . . . . . . . Parameters . . . . . . . . . . Usage . . . . . . . . . . . . Sending rich text fields . . . . . . Mail-related fields in a document . . . Language cross-reference . . . . . Examples: @MailSend . . . . . . @MailSignPreference . . . . . . . . Syntax . . . . . . . . . . . . Return value . . . . . . . . . Usage . . . . . . . . . . . . Language cross-reference . . . . . Examples: @MailSignPreference . . . @Matches . . . . . . . . . . . Syntax . . . . . . . . . . . . Parameters . . . . . . . . . . Return value . . . . . . . . . Language cross-reference . . . . . Examples: @Matches . . . . . . . @Max . . . . . . . . . . . . . Syntax . . . . . . . . . . . . Parameters . . . . . . . . . . Return value . . . . . . . . . Usage . . . . . . . . . . . . Examples: @Max . . . . . . . . @Member . . . . . . . . . . . Syntax . . . . . . . . . . . . Parameters . . . . . . . . . . Return value . . . . . . . . . Examples: @Member . . . . . . . @Middle . . . . . . . . . . . . Syntax . . . . . . . . . . . . Parameters . . . . . . . . . . Return value . . . . . . . . . Language cross-reference . . . . . Examples: @Middle . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

352 352 352 352 353 353 353 353 353 354 354 354 354 354 354 354 354 354 355 355 355 355 355 355 355 355 356 357 357 358 358 358 358 358 359 359 359 359 359 359 359 359 360 360 361 361 361 361 361 361 362 362 362 362 362 363 363 363 363 363 363

xii


@MiddleBack . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Examples: @MiddleBack . @Min . . . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Usage . . . . . . . Examples: @Min . . . @Minute . . . . . . . Syntax . . . . . . Parameters . . . . . Return value . . . . Language cross-reference Examples: @Minute . . @Modified . . . . . . Syntax . . . . . . Return value . . . . Usage . . . . . . . Language cross-reference Examples: @Modified. . @Modulo . . . . . . . Syntax . . . . . . Parameters . . . . . Return value . . . . Usage . . . . . . . Language cross-reference Examples: @Modulo . . @Month . . . . . . . Syntax . . . . . . Parameters . . . . . Return value . . . . Language cross-reference Examples: @Month . . @Name . . . . . . . Syntax . . . . . . . Parameters . . . . . Usage . . . . . . . Language cross-reference Examples: @Name . . . @NameLookup . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Usage . . . . . . . Examples: @NameLookup @Narrow . . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Usage . . . . . . . Language cross-reference Examples: @Narrow . . @NewLine . . . . . . Syntax . . . . . . . Return value . . . . Usage . . . . . . . Language cross-reference Examples: @NewLine. .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

364 364 364 365 365 365 365 365 365 366 366 366 366 366 366 366 366 367 367 367 367 367 367 367 367 368 368 368 368 368 368 368 368 369 369 369 369 369 369 372 373 373 374 374 374 375 375 375 376 376 376 376 376 376 376 376 376 377 377 377 377

@No . . . . . . . . . . . Syntax . . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Examples: @No . . . . . . . @NoteID . . . . . . . . . . Syntax . . . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . @Nothing . . . . . . . . . Syntax . . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . @Now . . . . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @Now . . . . . . @OptimizeMailAddress . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Examples: @OptimizeMailAddress @OrgDir . . . . . . . . . . Syntax . . . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Examples: @OrgDir . . . . . @Password . . . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Examples: @Password . . . . @PasswordQuality . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . @Pi . . . . . . . . . . . . Syntax . . . . . . . . . . Return value . . . . . . . Language cross-reference . . . Examples: @Pi . . . . . . . @PickList . . . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @PickList . . . . . @Platform . . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

377 378 378 378 378 378 378 378 378 378 378 378 379 379 379 379 379 379 379 380 380 380 380 380 380 380 380 381 381 381 381 381 381 381 381 381 381 382 382 382 382 382 382 382 382 382 382 383 383 383 383 383 385 385 386 386 386 386 386 386 387

Contents

xiii

Language cross-reference . . @PolicyIsFieldLocked . . . . . Syntax . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Examples: @PolicyIsFieldLocked @PostedCommand . . . . . Syntax . . . . . . . . . Paramters . . . . . . . Usage . . . . . . . . . @Power . . . . . . . . . Syntax . . . . . . . . Parameters . . . . . . . Return value . . . . . . Language cross-reference . . Examples: @Power . . . . @Prompt . . . . . . . . . Summary of Dialog Box Styles Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @Prompt . . . . @ProperCase . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @ProperCase . . . @Random . . . . . . . . Syntax . . . . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @Random . . . . @RefreshECL . . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Usage . . . . . . . . . Examples: @RefreshECL . . . @RegQueryValue . . . . . . Syntax . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Examples: @RegQueryValue . REM . . . . . . . . . . Syntax . . . . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: REM . . . . . @Repeat . . . . . . . . . Parameters . . . . . . . Return value . . . . . . Usage . . . . . . . . . Language cross-reference . . Examples: @Repeat . . . . @Replace . . . . . . . . . Syntax . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

388 388 388 388 388 388 388 388 388 389 389 389 389 389 389 389 389 390 390 390 390 392 392 392 392 393 393 394 394 394 394 394 394 394 394 394 394 395 395 395 395 395 395 395 395 395 396 396 396 396 396 396 396 397 397 397 397 397 397 398 398

Parameters . . . . . . Return value . . . . . Language cross-reference . Examples: @Replace . . . @ReplaceSubstring . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @ReplaceSubstring @ReplicaID . . . . . . . Syntax . . . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @ReplicaID . . @Responses . . . . . . . Syntax . . . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @Responses . . @Return . . . . . . . . Syntax . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @Return . . . @Right . . . . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Language cross-reference . Examples: @Right . . . . @RightBack . . . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Language cross-reference . Examples: @RightBack . . @Round . . . . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @Round . . . @Second . . . . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Language cross-reference . Examples: @Second . . . SELECT . . . . . . . . Syntax . . . . . . . . Usage . . . . . . . . Language cross-reference . Examples: SELECT . . . @Select . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

398 398 398 398 399 399 399 399 399 399 400 400 400 400 400 400 400 400 400 400 401 401 401 401 401 401 401 401 401 401 402 402 402 402 402 403 403 403 403 403 403 403 404 404 404 404 404 404 404 405 405 405 405 405 405 405 405 406 406 406 407

xiv


Syntax . . . . . . . . Parameters . . . . . . Examples: @Select . . . . @ServerAccess . . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Examples: @ServerAccess . @ServerName . . . . . . Syntax . . . . . . . . Return value . . . . . Language cross-reference . Examples: @ServerName . @Set . . . . . . . . . Syntax . . . . . . . . Parameters . . . . . . Usage . . . . . . . . Language cross-reference . Examples: @Set . . . . . @SetDocField . . . . . . Syntax . . . . . . . . Parameters . . . . . . Usage . . . . . . . . Language cross-reference . Examples: @SetDocField . . @SetEnvironment . . . . . Syntax . . . . . . . . Parameters . . . . . . Usage . . . . . . . . Language cross-reference . @SetField . . . . . . . . Syntax . . . . . . . . Parameters . . . . . . Usage . . . . . . . . Language cross-reference . Examples: @SetField . . . @SetHTTPHeader . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @SetHTTPHeader @SetProfileField . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @SetProfileField . @SetTargetFrame . . . . . Syntax . . . . . . . . Parameters . . . . . . Usage . . . . . . . . Language cross-reference . Examples: @SetTargetFrame @SetViewInfo . . . . . . Syntax . . . . . . . . Parameters . . . . . . Usage . . . . . . . . Examples: @SetViewInfo . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

407 407 407 407 407 407 409 409 409 409 409 410 410 410 410 410 410 410 410 411 411 411 411 411 411 412 412 412 412 413 413 413 413 413 413 413 414 414 414 414 414 414 414 415 415 415 415 415 415 415 416 416 416 416 416 417 417 417 417 418 418

@Sign . . . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Language cross-reference Examples: @Sign . . . @Sin . . . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Language cross-reference Examples: @Sin . . . . @Sort . . . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Usage . . . . . . . Examples: @Sort . . . @Soundex . . . . . . Syntax . . . . . . Parameters . . . . . Return value . . . . Usage . . . . . . . Examples: @Soundex . . @Sqrt . . . . . . . . Syntax . . . . . . . Parameters . . . . . Language cross-reference Examples: @Sqrt . . . @StatusBar . . . . . . Syntax . . . . . . . Return value . . . . Usage . . . . . . . Examples: @StatusBar . @Subset . . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Examples: @Subset . . @Success . . . . . . . Syntax . . . . . . Return value . . . . Usage . . . . . . . Examples: @Success . . @Sum . . . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Usage . . . . . . . Language cross-reference Examples: @Sum . . . @Tan . . . . . . . . Syntax . . . . . . . Parameters . . . . . Return value . . . . Language cross-reference Examples: @Tan . . . @TemplateVersion . . . . Syntax . . . . . . . Return value . . . . Usage . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

418 418 418 418 418 419 419 419 419 419 419 419 419 419 419 420 420 421 422 422 422 422 422 422 422 422 422 422 422 423 423 423 423 423 423 423 423 423 423 424 424 424 424 424 424 424 424 424 424 425 425 425 425 425 425 425 425 426 426 426 426

Contents

xv

@Text . . . . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . @Text with timedate components @Text with number values . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @Text . . . . . . @TextToNumber . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @TextToNumber . . . @TextToTime . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @TextToTime . . . . @ThisName . . . . . . . . . Syntax . . . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @ThisName . . . . @ThisValue . . . . . . . . . Syntax . . . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . Examples: @ThisValue . . . . @Time . . . . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Language cross-reference . . . Examples: @Time . . . . . . @TimeMerge . . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Examples: @TimeMerge . . . . @TimeToTextInZone . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Examples: @TimeToTextInZone . @TimeZoneToText . . . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . . Examples: @TimeZoneToText . . @Today . . . . . . . . . . Syntax . . . . . . . . . . Return value . . . . . . . Usage . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

426 426 426 426 426 427 427 428 428 428 428 428 429 429 429 429 429 429 429 429 430 430 430 430 430 430 430 430 431 431 431 431 431 431 431 431 432 432 432 432 432 433 433 433 433 433 433 433 433 434 434 434 434 435 435 435 435 435 435 436 436

Language cross-reference . . . . Examples: @Today . . . . . . . @Tomorrow . . . . . . . . . . Syntax . . . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: @Tomorrow . . . . . @ToNumber . . . . . . . . . . Syntax . . . . . . . . . . . Parameters . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: @ToNumber . . . . . @ToTime . . . . . . . . . . . Syntax . . . . . . . . . . . Parameters . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: @ToTime . . . . . . @Transform . . . . . . . . . . Syntax . . . . . . . . . . . Parameters . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: @Transform . . . . . @Trim . . . . . . . . . . . . Syntax . . . . . . . . . . . Parameters . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: @Trim . . . . . . . @True . . . . . . . . . . . . Syntax . . . . . . . . . . . Return value . . . . . . . . Language cross-reference . . . . Examples: @True . . . . . . . @Unavailable . . . . . . . . . Syntax . . . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: @Unavailable . . . . . @UndeleteDocument . . . . . . . Syntax . . . . . . . . . . . Usage . . . . . . . . . . . Examples: @UndeleteDocument . . @Unique . . . . . . . . . . . Syntax . . . . . . . . . . . Parameters . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: @Unique . . . . . . @UpdateFormulaContext . . . . . Syntax . . . . . . . . . . . Usage . . . . . . . . . . . Examples: @UpdateFormulaContext .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

436 436 436 436 436 436 437 437 437 437 437 437 437 437 438 438 438 438 438 438 438 438 438 439 439 439 439 439 439 440 440 440 440 440 440 440 440 440 441 441 441 441 441 441 441 441 442 442 442 442 442 442 442 442 443 443 443 443 443 443 443

xvi


@UpperCase . . . . . . . Syntax . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @UpperCase . . @URLDecode . . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Examples: @URLDecode . . @URLEncode . . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Examples: @URLEncode . . @URLGetHeader . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Examples: @URLGetHeader @URLHistory . . . . . . Syntax . . . . . . . . Parameters . . . . . . Usage . . . . . . . . Examples: @URLHistory . @URLOpen . . . . . . . Syntax . . . . . . . . Parameters . . . . . . Usage . . . . . . . . Language cross-reference . Examples: @URLOpen . . @UrlQueryString . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Examples: @UrlQueryString @UserAccess . . . . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @UserAccess . . @UserName . . . . . . . Notes . . . . . . . . Syntax . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . . Language cross-reference . Examples: @UserName . . @UserNameLanguage . . . Syntax . . . . . . . . Parameters . . . . . . Return value . . . . . Usage . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

444 444 444 444 444 444 444 444 444 445 445 445 445 445 445 446 446 446 446 446 446 447 447 447 447 447 448 448 448 448 449 449 450 451 451 451 452 452 452 452 452 452 452 453 453 454 454 454 454 454 454 455 455 455 455 455 456 456 456 456 456

Language cross-reference . . . . Examples: @UserNameLanguage . . @UserNamesList . . . . . . . . Syntax . . . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Examples: @UserNamesList . . . @UserPrivileges . . . . . . . . Syntax . . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: @UserPrivileges . . . . @UserRoles . . . . . . . . . . Syntax . . . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: @UserRoles . . . . . @V2If . . . . . . . . . . . . Syntax . . . . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . @V3UserName . . . . . . . . . Syntax . . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: @V3UserName . . . . @V4UserAccess . . . . . . . . . Syntax . . . . . . . . . . . Parameters . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: @V4UserAccess . . . . @ValidateInternetAddress . . . . . Syntax . . . . . . . . . . . Parameters . . . . . . . . . Return value . . . . . . . . Possible error messages . . . . . Usage . . . . . . . . . . . Examples: @ValidateInternetAddress @VerifyPassword . . . . . . . . Syntax . . . . . . . . . . . Parameters . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . @Language cross-reference . . . . Examples: @VerifyPassword . . . @Version . . . . . . . . . . . Syntax . . . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . @ViewShowThisUnread . . . . . . Syntax . . . . . . . . . . . Parameters . . . . . . . . . Return value . . . . . . . . Usage . . . . . . . . . . . @ViewTitle . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

456 457 457 457 457 457 457 457 458 458 458 458 458 458 458 458 458 459 459 459 459 459 459 459 460 460 460 460 460 461 461 461 461 461 462 462 462 462 462 463 463 463 463 464 464 464 464 464 464 464 464 465 465 465 465 465 465 466 466 466 466

Contents

xvii

Syntax . . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @ViewTitle . . . . . . . . @WebDbName . . . . . . . . . . . . Syntax . . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @WebDbName . . . . . . . @Weekday . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @Weekday. . . . . . . . . @While . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @While . . . . . . . . . . @Wide. . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @Wide . . . . . . . . . . @Word . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Return value . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @Word . . . . . . . . . . @Year . . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @Year . . . . . . . . . . @Yes . . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @Yes . . . . . . . . . . @Yesterday . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @Yesterday . . . . . . . . @Zone . . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Return value . . . . . . . . . . . Usage . . . . . . . . . . . . . . Time zones that are not full-hour increments from GMT . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

466 466 466 466 466 467 467 467 467 467 467 467 467 468 468 468 468 468 468 468 468 468 469 469 469 469 469 469 469 469 469 470 470 470 470 470 471 471 471 471 471 471 471 471 471 471 471 471 472 472 472 472 472 472 472 472 472 472 473

Language cross-reference Examples: @Zone . . .

. .

. .

. .

. .

. .

. .

. .

. 473 . 474

Chapter 7. Formula Language @Commands A-Z. . . . . . . . . . 475Using @Commands . . . . . . . Syntax . . . . . . . . . . . Parameters . . . . . . . . . Return value . . . . . . . . @Commands with ECL security . . . AddBookmark @Command . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . . Usage . . . . . . . . . . . Examples: AddBookmark . . . . AddDatabase @Command . . . . . Syntax . . . . . . . . . . Parameters . . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . Examples: AddDatabase . . . . . AddDatabaseRepID @Command . . . Syntax . . . . . . . . . . Parameters . . . . . . . . . Usage . . . . . . . . . . . AddToIMContactList @Command . . Syntax . . . . . . . . . . Parameters . . . . . . . . . AdminCertify @Command . . . . . Syntax . . . . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . AdminCreateGroup @Command . . . Syntax . . . . . . . . . . Usage . . . . . . . . . . . AdminCrossCertifyIDFile @Command . Syntax . . . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . AdminCrossCertifyKey @Command . . Syntax . . . . . . . . . . Usage . . . . . . . . . . . AdminDatabaseAnalysis @Command . Syntax . . . . . . . . . . . Usage . . . . . . . . . . . AdminDatabaseQuotas @Command . . Syntax . . . . . . . . . . . Usage . . . . . . . . . . . Language cross-reference . . . . AdminIDFileClearPassword @Command Syntax . . . . . . . . . . Usage . . . . . . . . . . . AdminIDFileExamine @Command . . Syntax . . . . . . . . . . . Usage . . . . . . . . . . . AdminIDFileSetPassword @Command . Syntax . . . . . . . . . . . Usage . . . . . . . . . . . Administration @Command . . . . Syntax . . . . . . . . . . . Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475 475 475 475 475 477 477 477 478 478 478 478 478 478 478 479 479 479 479 479 479 479 480 480 480 480 480 480 480 480 480 481 481 481 481 481 481 481 481 481 481 481 481 482 482 482 482 482 482 482 482 482 482 482 482 482

. 473

xviii


AdminNewOrganization @Command Syntax . . . . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . AdminNewOrgUnit @Command . . Syntax . . . . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . AdminOpenAddressBook @Command Syntax . . . . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . AdminOpenCatalog @Command . . Syntax . . . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . AdminOpenCertLog @Command . . Syntax . . . . . . . . . Usage . . . . . . . . . . AdminOpenGroupsView @Command Syntax . . . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . AdminOpenServerLog @Command . Syntax . . . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . AdminOpenServersView @Command Syntax . . . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . AdminOpenStatistics @Command . Syntax . . . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . AdminOpenUsersView @Command . Syntax . . . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . AdminOutgoingMail @Command . Syntax . . . . . . . . . Usage . . . . . . . . . . AdminRegisterFromFile @Command Syntax . . . . . . . . . . Usage . . . . . . . . . . AdminRegisterServer @Command . Syntax . . . . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . AdminRegisterUser @Command . . Syntax . . . . . . . . . . Usage . . . . . . . . . . Language cross-reference . . . AdminRemoteConsole @Command . Syntax . . . . . . . . . . Usage . . . . . . . . . . AdminSendMailTrace @Command . Syntax . . . . . . . . . . Usage . . . . . . . . . . AdminStatisticsConfig @Command . Syntax . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

483 483 483 483 483 483 483 483 483 483 483 484 484 484 484 484 484 484 484 484 484 484 485 485 485 485 485 485 485 485 485 485 486 486 486 486 486 486 486 486 486 486 487 487 487 487 487 487 487 487 487 487 487 487 487 487 488 488 488 488 488

Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . AdminTraceConnection @Command . . . . . Syntax . . . . . . . . . . . . . Usage . . . . . . . . . . . . . . AgentEdit @Command . . . . . . . . . Syntax . . . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . AgentEnableDisable @Command . . . . . . Syntax . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . AgentLog @Command . . . . . . . . . Syntax . . . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . AgentRun @Command . . . . . . . . . Syntax . . . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . AgentSetServerName @Command . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . AgentTestRun @Command . . . . . . . . Syntax . . . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . AttachmentDetachAll @Command . . . . . Syntax . . . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . AttachmentLaunch @Command . . . . . . Syntax . . . . . . . . . . . . . Usage . . . . . . . . . . . . . . Language cross-reference . . . . . . . Examples: @Command([AttachmentLaunch]) AttachmentProperties @Command . . . . . Syntax . . . . . . . . . . . . . Usage . . . . . . . . . . . . . . AttachmentView @Command . . . . . . . Syntax . . . . . . . . . . . . . Usage . . . . . . . . . . . . . . CalendarFormat @Command . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Usage . . . . . . . . . . . . . . CalendarGoTo @Command . . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Usage . . . . . . . . . . . . . . CheckCalendar @Command . . . . . . . Syntax . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Usage . . . . . . . . . . . . . . Examples: CheckCalendar . . . . . . . ChooseFolders @Command . . . . . . . . Syntax . . . . . . . . . . . . .Contents

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

488 488 488 488 488 489 489 489 489 489 489 489 489 489 489 490 490 490 490 490 490 490 490 490 490 490 491 491 491 491 491 491 491 491 491 491 492 492 492 492 492 492 492 492 49

lotus-domino-designer programming guide vol1

Documents