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.getPurgedRowCount()
This method enables you to retrieve the number of Service Manager records that were deleted from a table after invoking the doPurge() method.
Syntax
SCFile_object.getPurgedRowCount();
Arguments
There are no arguments for this method.
Return values
- If successful, getPurgedRowCount() returns the number of records deleted by the last successful doPurge() call (which returned
RC_SUCCESS
). This value can be 0 if no records were deleted. - If getPurgedRowCount() is not able to retrieve the record count it will return
-1
.
The value returned by getPurgedRowCount is unaffected by any SCFile method call other than doPurge. It is also unaffected by a failed call to doPurge (returned RC_ERROR
).
Example
This example does the following:
- Searches the kmknowledgebaseupdates table for records where docid="docid1"
- Deletes whatever it finds.
This example requires the following sample data:
- Records in kmknowledgebaseupdates table where docid = "docid1"
var fileName = "kmknowledgebaseupdates"; var recordList = new SCFile(fileName); var deleteRC = recordList.doPurge("docid = \"docid1\""); if ( deleteRC == RC_SUCCESS ) { print ("doPurge succeeded"); var purgedCount = recordList.getPurgedRowCount(); if ( purgedCount >= 0 ) { print(purgedCount + " records have been purged"); } else { print("Could not retrieve purged record count"); } } else { print ("doPurge failed"); }
JavaScript object: SCFile
JavaScript method: SCFile.doPurge()