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.
Words and Phrases
| 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. |
Using Boolean Operators
| 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: cleanup
A RAD function that frees the storage associated with a variable.
Function
cleanup
Format
cleanup($filename, [$fieldname], [index])
Parameters
The following parameters are valid for this function.
|
Parameter |
Description |
|---|---|
|
$filename |
The variable that you want to clean up. If only $filename is specified, this variable can be a file variable or a field. |
|
[$fieldname] |
Optional. When specified, indicates the name of a field whose field value and display value (if any) are to be cleaned up. Note Fields that have a referenced table defined have a display value. |
|
[index] |
Optional. If the field specified in $fieldname is of the array type, the value and display value (if any) of the element that has the specified index or position number in that array are cleaned up. |
Factors
If only $filename is specified when calling this function, this function returns the same result as it would in versions earlier than 9.41.
This function does not return a value. It cleans up (empties) the variable or field specified by setting the value to NULL.
You can use this function on any variable type (local, thread, or global), but it is generally used on local and thread variables to clean up values before a user logs out.
This is the preferred way to clean up both variables and fields in records as opposed to $x=NULL or field in $file=NULL.
Unless you run this function, variables remain in memory until their defining environment ends.
For local variables, this is the parent RAD program. For thread variables, this is the parent RAD thread. For global variables, this is the user session.
Note This RAD function is not available as a JavaScript system.functions call.
Return values
None
Examples
cleanup($file)
cleanup($file, “logical.name”)
cleanup($file, “assets”, 0)
