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 |
|
- JavaScript object: SCFile
- JavaScript method: SCFile.deleteAttachment( attachID )
- JavaScript method: SCFile.deleteAttachments()
- JavaScript method: SCFile.doAction()
- JavaScript method: SCFile.doCount()
- JavaScript method: SCFile.doDelete()
- JavaScript method: SCFile.doInsert()
- JavaScript method: SCFile.doPurge()
- JavaScript method: SCFile.doRemove()
- JavaScript method: SCFile.doSave()
- JavaScript method: SCFile.doSelect()
- JavaScript method: SCFile.doUpdate()
- JavaScript method: SCFile.getAttachment( attachID )
- JavaScript method: SCFile.getattachments()
- JavaScript method: SCFile.getBinary()
- JavaScript method: SCFile.getFirst()
- JavaScript method: SCFile.getLast()
- JavaScript method: SCFile.getLastRC()
- JavaScript method: SCFile.getMessages()
- JavaScript method: SCFile.getNext()
- JavaScript method: SCFile.getPrev()
- JavaScript method: SCFile.getPurgedRowCount()
- JavaScript method: SCFile.getText()
- JavaScript method: SCFile.getType()
- JavaScript method: SCFile.getXML()
- JavaScript method: SCFile.insertattachment()
- JavaScript method: SCFile.isRecord()
- JavaScript method: SCFile.setBinary()
- JavaScript method: SCFile.setFields()
- JavaScript method: SCFile.setOrderBy()
- JavaScript method: SCFile.setRecord()
- JavaScript method: SCFile.updateAttachment( attachObj )
JavaScript method: SCFile/SCDatum.getText()
This method returns a text string representation of the current SCFile or SCDatum object. The text string has the following format:
table={["field value",{"array value","array value"},...]}
Syntax
SCFile_object.getText();
SCDatum_object.getText();
Arguments
There are no arguments for this method.
Return values
A string and RC_SUCCESS
or one of the other global return code values.
The method returns a text string containing the current SCFile or SCDatum object and a global return code value of RC_SUCCESS
, or returns one of the error global return code values if the method cannot return a string.
Example
This example does the following:
- Searches the contacts table for any contact name you define in the search variable
- Displays the contact record as a text string
This example requires the following sample data:
- A valid contact name (for example, "ADMINISTRATOR, SYSTEM")
- A invalid contact name (for example, "NOT A, CONTACT")
var contactName; function findContactName( name ) { print( "Searching for contact: " + name + "..." ); var contactList = new SCFile( "contacts" ); var findContact = contactList.doSelect( "contact.name=\""+ name + "\"" ) if ( findContact == RC_SUCCESS ) { print( "Success. found " + name + " in contact record:\n" + contactList.getText() ); return contactList } else { print( "Could not find contact. " + RCtoString( findContact ) ); return null } } contactName = "ADMINISTRATOR, SYSTEM"; findContactName( contactName ); contactName = "NOT A, CONTACT"; findContactName( contactName );