Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
- List: RAD functions
- RAD function: add.graphnodes(xml)
- RAD function: cache.flush
- RAD function: clean.display.value
- RAD function: cleanup
- RAD function: contents
- RAD function: copyright
- RAD function: currec
- RAD function: current.device
- RAD function: current.format
- RAD function: cursor.field.contents
- RAD function: cursor.field.display.content
- RAD function: cursor.field.display.content.set
- RAD function: cursor.field.name.set
- RAD function: cursor.field.name
- RAD function: cursor.field.readonly
- RAD function: cursor.line
- RAD function: date
- RAD function: datecmp
- RAD function: day
- RAD function: dayofweek
- RAD function: dayofyear
- RAD function: dbdict.helper(“db.type”)
- RAD function: dbdict.helper(“field.type”)
- RAD function: dbdict.helper(“is.alias”)
- RAD function: dbdict.helper(“joinfile.names”)
- RAD function: dbdict.helper(“unique.key”)
- RAD function: delete
- RAD function: denull
- RAD function: descriptor
- RAD function: display.value.copy
- RAD function: evaluate
- RAD function: evaluate.query
- RAD function: evaluate_query
- RAD function: exists
- RAD function: fduplicate
- RAD function: filename
- RAD function: filequeryex
- RAD function: frestore
- RAD function: genout
- RAD function: get.base.form.name
- RAD function: get.dateformat
- RAD function: get.display.value
- RAD function: get.graph.action
- RAD function: get.graph.id
- RAD function: get.graph.target
- RAD function: get.graphnode.id
- RAD function: get.lock.owner
- RAD function: get.timezoneoffset
- RAD function: get.uid
- RAD function: gui
- RAD function: index
- RAD function: insert
- RAD function: iscurrent
- RAD function: isExpressionValid
- RAD function: isfileexist
- RAD function: jscall
- RAD function: lioption
- RAD function: lng
- RAD function: locks
- RAD function: logoff
- RAD function: logon
- RAD function: mandant
- RAD function: max
- RAD function: messages
- RAD function: min
- RAD function: modtime
- RAD function: month
- RAD function: multiselect.selection("fieldcontents")
- RAD function: multiselect.selection("fieldname")
- RAD function: multiselect.selection("rows")
- RAD function: multiselect.selection("selected")
- RAD function: multiselect.selection("selections")
- RAD function: multiselect.selection("tablename")
- RAD function: null
- RAD function: nullsub
- RAD function: operator
- RAD function: option
- RAD function: parse
- RAD function: perf
- RAD function: printer
- RAD function: policyread
- RAD function: processes
- RAD function: prof
- RAD function: recordcopy
- RAD function: recordtostring
- RAD function: round
- RAD function: same
- RAD function: scmsg
- RAD function: set.display.value
- RAD function: set.timezone
- RAD function: setsort
- RAD function: shutdown
- RAD function: simple.file.load
- RAD function: sleep
- RAD function: str
- RAD function: stradj
- RAD function: strchrcp
- RAD function: strchrin
- RAD function: strclpl
- RAD function: strclpr
- RAD function: strcpy
- RAD function: strdel
- RAD function: strins
- RAD function: strpadl
- RAD function: strpadr
- RAD function: strraw
- RAD function: strrep
- RAD function: strtml
- RAD function: strtrmr
- RAD function: substr
- RAD function: substrb
- RAD function: sysinfo.get("ActiveFloatUsers")
- RAD function: sysinfo.get("Active Licenses")
- RAD function: sysinfo.get("ActiveNamedUsers")
- RAD function: sysinfo.get("AuthMode")
- RAD function: sysinfo.get("ClientNetAddress")
- RAD function: sysinfo.get("ClientOSName")
- RAD function: sysinfo.get("ClientPID")
- RAD function: sysinfo.get("ClientVersion")
- RAD function: sysinfo.get("Display")
- RAD function: sysinfo.get("Environment")
- RAD function: sysinfo.get("languagecode")
- RAD function: sysinfo.get("MaxFloatUsers")
- RAD function: sysinfo.get("MaxLicenses")
- RAD function: sysinfo.get("Mode")
- RAD function: sysinfo.get("PrevLabel")
- RAD Function: sysinfo.get("PKMode")
- RAD function: sysinfo.get("PrintOption")
- RAD function: sysinfo.get("Quiesce")
- RAD function: sysinfo.get("RecList")
- RAD function: sysinfo.get("ServerNetAddress")
- RAD function: sysinfo.get("ServerNetPort")
- RAD function: sysinfo.get("ServerPID")
- RAD function: sysinfo.get("ThreadID")
- RAD function: sysinfo.get("TotalFloatUsers")
- RAD function: sysinfo.get("TotalLicenses")
- RAD function: sysinfo.get("TotalNamedUsers")
- RAD function: sysinfo.get("TotalProcs")
- RAD function: sysinfo.get("TotalSystemProcs")
- RAD function: sysinfo.get("TotalUserProcs")
- RAD function: time
- RAD function: tod
- RAD function: tolower
- RAD function: toupper
- RAD function: translate
- RAD function: trunc
- RAD function: type
- RAD function: updatestatus
- RAD function: val
- RAD function: version
- RAD function: year
RAD function: scmsg
Returns a text string matching the format of the message ID number and message class specified. The function replaces any variables in the message with the text specified in an array of values.
Function
scmsg
Format
scmsg($id, $class, $arrayof values)
Parameters
The following parameters are valid for the scmsg function:
Parameter | Data type | Description |
---|---|---|
$id | Number | The ID number of the message (message.id) from the scmessage table. |
$class | String | The Message class from the scmessage table. |
$arrayofvalues | Array | An array of substitution text for the %S variables in the message text from the
scmessage table. |
Factors
- All substitution text must be
%S
, which indicates that a string is used to provide the data. Each entry in the array of substitution text is examined for the type. If it is not a string type, it is converted to a string. - You must create a separate record in the scmessage table for the message in each language you want to display.
- The $arrayofvalues defined in the scmsg function are applied to the message in the scmessage table corresponding to the language defined for the client login.
-
When adding a scmessage record to the scbutton class, the scballoon class, the sccaption class, and the sctitle class, the message ID must end with
_<number>
.<number>
is a string of decimal positions of the uppercase characters in the message ID. For example,My Affected Example_1413
. In this example,1413
symbolizes the positions of the uppercase characters ofM
(1),A
(4), andE
(13) in the message ID, respectively. -
When calling the
scmsg()
function, the message ID must be used without the_<number>
suffix.
Example
scmsg("21", "cib", {"mail", "middle,caller.id", "open"})
Resulting message from the scmessage table:
Built macro to %S to %S on %S.
When the %S array values from the scmsg function in the example are applied, the message is displayed as:
Built macro to mail to middle,caller.id on open