Table 1 lists the conventions that the Oracle Essbase API Reference uses to make code and examples easier to understand.
Table 1. Syntax and Text Formatting Conventions
Convention | Purpose | Example |
---|---|---|
monospace font | Function, structure, file, directory, and environment variables names in text | ESS_STS_T, ESSAPIW.LIB |
italic | Anything you replace with a value in syntax | EsbOtlCloseOutline (hOutline) |
" " | Double quotes enclose text parameters or parameters that include a space | "appName"
SETDEFAULTCALC "CALC ALL"; |
() | Parentheses enclose function parameters, show order of execution for operations | EsbOtlDeleteMember
(hOutline, hMember);
(a + b) * c |
// | Comment marker indicates text from // to end of line should be ignored in processing | // Gets results |
; | Statement terminator marks end of command | EXIT; |