Alphabetical List of Functions and Statements

The following table lists functions and statements that can be used in logic. Listings that are marked ^(CS) are part of the Action Invoker. In addition, some CSPro objects have functions that can be invoked on the object. A list of such functions can be found in the summary pages for each of these objects:

Function/Statement	Description
abs	Returns the absolute value of a numeric expression.
accept	Returns the number of a choice from a list made by the data entry operator.
adjlba	Adjusts the lower bound of the CMC of an event based on an age.
adjlbi	Adjusts the lower bound of the CMC of an event offset by a number of months.
adjuba	Adjusts the upper bound of the CMC of an event based on an age.
adjubi	Adjusts the upper bound of the CMC of an event offset by a number of months.
advance	Moves forward field by field to a specified field during data entry.
alias	Creates an aliased name for a dictionary item, typically to shorten or standardize names.
alpha	Declares alphanumeric variables used in the application.
Application.getFormFile ^(CS)	Returns a form file associated with an application or loaded from the disk.
Application.getQuestionnaireContent ^(CS)	Returns the questionnaire content associated with an application, form file, or dictionary.
Application.getQuestionText ^(CS)	Returns the question text associated with an application or loaded from the disk.
Array	Declares an Array object for storing a collection of numbers or strings.
ask	Conditionally jumps forward to the next field during data entry.
Audio	Declares an Audio object for recording or playing audio.
average	Returns the average of an item that occurs multiple times.

Barcode.read	Reads a barcode and returns its value as a string.
break	Exits a do, while, or for loop early and continues execution with the first statement after the enddo.

changekeyboard	Modifies the keyboard input associated with certain fields.
clear	Initializes the memory values of data items defined in external files to zero or blank.
Clipboard.getText ^(CS)	Gets the text on the clipboard.
Clipboard.putText ^(CS)	Puts text onto the clipboard.
close	Closes a previously opened file.
cmcode	Returns the number of months since the year 1900 given a month and year.
compare	Returns the alphabetical order (i.e., collating sequence) of two strings using a case-sensitive comparison.
compareNoCase	Returns the alphabetical order of two strings using a case-insensitive comparison.
compress	Compresses some number of files into a single ZIP file.
concat	Joins two or more strings into one string.
config	Declares string variables prefilled with values defined in the configuration settings.
connection	Determines whether the device has access to the Internet.
count	Returns the number of occurrences for a repeating form or roster.
countcases	Returns the number of cases in an external file that meet a certain criterion.
countnonspecial	Returns the number of non-special values in a group of data items.
curocc	Returns the current occurrence number for a repeating form, roster, or record.
currentkey	Returns the key (ID string) comprised of the case's current IDs.

Data.getCase ^(CS)	Returns a specific case, or the current case, associated with a dictionary.
dateadd	Calculates a new date from a starting date and a period of elapsed time.
datediff	Calculates the difference between two dates.
datevalid	Determines whether a date in the format YYYYMMDD is valid.
declare	Declares a variable, allowing it to be used in logic prior to it being defined.
decompress	Decompresses a ZIP file, extracting some number of files.
delcase	Marks a case for deletion in an external file based on a key.
delete	Removes a record or item occurrence from the current case.
demode	Returns the current data entry mode.
diagnostics	Returns troubleshooting information about CSPro.
Dictionary.getDictionary ^(CS)	Returns a dictionary associated with an application or loaded from the disk.
dircreate	Creates a new directory with the given directory name.
dirdelete	Deletes an empty directory or group of empty directories.
direxist	Determines whether a directory exists.
dirlist	Returns a list containing the file and directory listing of the specified directory.
display	Displays a message (this function has been superceded by errmsg).
do	Executes one or more statements repeatedly while a logical condition remains true or until a logical condition is no longer true.
Document	Declares a Document object for storing text or binary files.

edit	Converts a number to a string.
editnote	Displays the data entry note box for adding or changing.
encode	Encodes special characters to facilitate writing to HTML or CSV files and writing to other formats.
endcase	Ends batch editing for the current case (but outputs the case to file).
endgroup	Ends data entry for the current record or group/roster.
endlevel	Ends data entry for the current level.
enter	Enters data from a secondary form file.
errmsg	Displays or writes a message.
ensure	Conditionally declares numeric variables used in the application.
execpff	Starts another CSPro application.
execsystem	Starts another application or process.
execute ^(CS)	Executes an action with the action name specified as an argument.
exit	Ends a procedure before normal processing is expected to end.
exp	Returns the value of e raised to a given power.
export	Writes a record to an export file.

File	Declares one or more File objects used in the application.
File.copy ^(CS)	Copies one or more files.
File.readBytes ^(CS)	Reads a file as binary, returning the entire file's content as bytes.
File.readLines ^(CS)	Reads a file as text, returning the entire file's content as an array of strings.
File.readText ^(CS)	Reads a file as text, returning the entire file's content as a string.
File.writeBytes ^(CS)	Writes bytes as a binary file.
File.writeLines ^(CS)	Writes an array of strings as lines to a text file.
File.writeText ^(CS)	Writes a string as a text file.
fileconcat	Concatenates a list of files or a set of files described by a wildcard specification.
filecopy	Copies a file to another file.
filecreate	Creates a new file with the given file name.
filedelete	Deletes a file or group of files.
fileempty	Determines whether a file exists but is empty.
fileexist	Determines whether a file exists.
filename	Returns the file name currently associated with a dictionary or a File.
fileread	Reads a text line from a File into an item or variable.
filerename	Changes the name of a file.
filesize	Returns the size of a file in bytes.
filetime	Returns the last modification date/time of a file or a directory.
filewrite	Writes a line of text to a File.
find	Determines the existence of a case in a data file that matches a condition.
for	Loops through multiple records or items.
for (dictionary)	Loops through the cases selected during a selcase operation.
forcase	Loops through the cases in an external file.
Freq	Declares a Freq object that allows for the creation of frequencies.
function	Declares a user-defined function.

Geometry	Declares a Geometry object for storing vector geometry.
getbluetoothname	Returns the name of the device as broadcast to other Bluetooth devices.
getbuffer	Returns a string containing the contents of a data item.
getcapturetype	Returns the capture type associated with a field.
getcaselabel	Returns a string containing a case's label (the text that appears in a case listing).
getdeck	Retrieves a value from a DeckArray used for editing data.
getdeviceid	Returns a string that contains a unique value that identifies the device.
getimage	Returns the filename of a value set image.
getlabel	Returns the label of a dictionary symbol or text associated to symbol's value.
getlanguage	Returns the current language being used while in data entry mode.
getnote	Returns a field or case note.
getocclabel	Returns an occurrence label associated with a repeating dictionary item or a roster.
getoperatorid	Returns the text entered in the operator ID.
getorientation	Returns the display orientation.
getos	Returns information about the operating system, including whether it is running Android or Windows.
getproperty	Returns information about an application or field property.
getrecord	Returns the name of the record containing a particular item.
getsymbol	Returns the name of the current procedure being executed.
getusername	Returns the name of the user logged into Windows or the Android device account.
getvalue	Returns the value of a numeric variable whose identity is only known at runtime.
getvaluealpha	Returns the value of a alpha variable whose identity is only known at runtime.
getvaluenumeric	Returns the value of a numeric variable whose identity is only known at runtime.
gps	Controls and returns values from a GPS receiver.

has	Determines whether any of a group of repeating items is within a range of values.
hash	Calculates the hash value of a string.
Hash.createHash ^(CS)	Creates a hash value based on the contents of a file, text, or bytes.
Hash.createMd5 ^(CS)	Creates a MD5 hash based on the contents of a file, text, or bytes.
HashMap	Declares a HashMap object for storing a collection of numbers or strings in an associative array.
hideocc	Visually hides an occurrence row in a roster.
high	Returns the maximum value in a group of numeric expressions.
highlighted	Returns whether a field is on path or reached during data entry.
htmldialog	Displays a custom dialog designed in HTML and JavaScript.

if	Executes statements conditionally.
Image	Declares an Image object for storing and manipulating images.
impute	Assigns a value to a data item and logs the frequency of assignments.
in	Determines whether a variable is within a range of values.
inadvance	Indicates if an advance is in progress.
inc	Increments a numeric item.
insert	Creates a record or item occurrence in the current case.
int	Returns the integer portion of a numeric expression.
invalueset	Determines whether a data item's value is within the item's value set.
invoke	Executes a user-defined function using runtime binding.
ischecked	Returns whether a code is checked as part of a check box field's selections.
ispartial	Determines whether a case was opened from a partial case or not.
isverified	Determines whether a case was verified by double-keying.

JS.eval	Evaluates JavaScript in the global execution context.
JS.getValue	Converts a JavaScript variable or property to its CSPro equivalent.
JS.getValueJson	Returns the JSON representation of a JavaScript variable or property.
JS.hasValue	Returns whether a JavaScript variable or property is defined (not undefined).
JS.invoke	Executes a JavaScript function that exists in the global execution context with any CSPro arguments converted to their JavaScript equivalents.
JS.setValue	Converts a CSPro variable to its JavaScript equivalent and adds this as a variable to the global scope, or sets an object's property.
JS.setValueFromJson	Create a JavaScript variable using JSON and adds it as a variable to the global scope, or sets an object's property.

key	Returns the key (ID string) of the case's IDs as they existed when the case was last loaded or written.
keylist	Returns a list containing the keys (ID strings) of cases in a file.
killfocus	Declares that the following statements are executed after the object stops being active.

length	Returns the length of a dictionary item or a string.
List	Declares a List object for storing a collection of numbers or strings.
loadcase	Reads a case from an external file into memory (usually based on a key).
loadsetting	Returns a string containing a setting saved using the savesetting function.
locate	Finds but does not load a case in an external file that matches a condition.
Localhost.mapActionResult ^(CS)	Creates a localhost URL that provides access to the result of an Action Invoker action.
Localhost.mapFile ^(CS)	Creates a localhost URL to access a file on the local file system.
Localhost.mapSymbol ^(CS)	Creates a localhost URL that provides access to a binary symbol's data.
Localhost.mapText ^(CS)	Creates a localhost URL that provides access to supplied text.
log	Returns the base-10 logarithm of a numeric expression.
Logic.eval ^(CS)	Evaluates and runs one or more logic statements.
Logic.getSymbol ^(CS)	Returns a symbol's metadata and value.
Logic.getSymbolMetadata ^(CS)	Returns a symbol's metadata.
Logic.getSymbolValue ^(CS)	Returns a symbol's value.
Logic.invoke ^(CS)	Executes a user-defined function using runtime binding.
Logic.setSymbolValue ^(CS)	Modifies a symbol based on a JSON representation of the value.
logtext	Writes a user-defined message to the paradata log file.
low	Returns the minimum value in a group of numeric expressions.

maketext	Returns a formatted string with inserted values.
Map	Declare a Map variable that can be used to display interactive maps.
max	Returns the maximum value of an item that occurs multiple times.
maxocc	Returns the maximum number of occurrences of a multiply occurring object.
maxvalue	Returns the maximum value in an item's range of acceptable values.
Message.formatText ^(CS)	Creates a formatted string with inserted values using base text specified by a message number or text.
Message.getText ^(CS)	Returns the base (unformatted) text for a message.
min	Returns the minimum value of an item that occurs multiple times.
minvalue	Returns the minimum value in an item's range of acceptable values.
move	Moves backwards or forwards to a specified field during data entry.

next	Ends a do, while, or for loop early and continues execution with the next iteration of the loop.
nmembers	Returns the number of cases selected during a selcase operation.
noccurs	Returns the number of occurrences for a repeating form or roster.
noinput	Prevents input for the current field during data entry.
numeric	Declares numeric variables used in the application.

OnActionInvokerResult	Provides a way to process a result from the Action Invoker when called from CSPro logic.
OnChangeLanguage	Provides control over actions to occur after a user has changed the language.
OnChar	Allows users to trap characters in order to perform special actions or to change the action of the character.
onfocus	Declares that the following statements are executed just before an object becomes active.
OnKey	Allows users to trap keystrokes in order to perform special actions or to change the action of the key.
onoccchange	Declares that the following statements are executed when the group's current occurrence changes.
OnRefused	Provides a way to override the selection of a refused value.
OnStop	Provides control over stopping or exiting data entry.
OnSyncMessage	Allows users to respond to a message sent by a Bluetooth client using syncmessage.
OnSystemMessage	Provides a way to override the displaying of system error messages.
OnViewQuestionnaire	Provides a way to override the displaying of the questionnaire view.
open	Opens a dictionary or external file.

paradata	Performs an action on the paradata log.
Path.concat	Combines multiple strings into one string representing a file path.
Path.createDirectory ^(CS)	Creates a directory if it does not already exist.
Path.getDirectoryListing ^(CS)	Returns information about the paths in a directory.
Path.getDirectoryName	Extracts the directory name from a file path.
Path.getExtension	Extracts the file extension from a file path.
Path.getFileName	Extracts the file name from a file path.
Path.getFileNameWithoutExtension	Extracts the file name without its extension from a file path.
Path.getPathInfo ^(CS)	Returns information about a directory or file path.
Path.getRelativePath	Returns a relative path based on a path's location relative to a directory.
Path.getSpecialPaths ^(CS)	Returns special paths, including the download and temp directories.
Path.selectFile ^(CS)	Shows the operator a visual listing of the file system and returns the path of the file the operator selected.
Path.selectFile	Shows the operator a visual listing of the file system and returns the path of the file the operator selected.
Path.showFileDialog ^(CS)	Displays a dialog with a visual listing of the file system, allowing the user to select a file to open or to create a file to save.
pathconcat	Combines multiple strings into one string representing a file path.
pathname	Returns the path of various special directories.
Pff	Declares a Pff object that can be used to dynamically modify the way other CSPro applications are executed.
pos	Returns the position of a string within another string.
poschar	Returns the position of any of a series of characters within another string.
preproc	Declares that the following statements are executed at the beginning of a block.
PROC	Declares the beginning of a new procedure.
prompt	Prompts the operator to enter an alphanumeric string, also supporting a password masking option.
protect	Modifies the protected property of a field.
postproc	Declares that the following statements are executed at the end of a block.
publishdate	Returns the date and time that the code was compiled (which can be used to determine when a .pen file was created).
putdeck	Puts a value in a DeckArray used for editing data.
putnote	Puts the contents of string to a field or case note.

QSF	Gives access to the StringWriter in use when processing question text as a text template.

random	Returns a pseudo-random integer in a given range.
randomin	Returns a pseudo-random integer in a non-continuous range, or using a value set.
randomizevs	Randomizes the order of a value set.
recode	Assigns a value to a variable based on the value of one or more other variables.
reenter	Forces the data entry operator to reenter a previous entered field.
regexmatch	Returns whether a string matches the regular expression.
registerAccessToken ^(CS)	Registers an access token to provide access to the Action Invoker from external callers.
replace	Returns a string with one of more instances of a substring replaced with new text.
Report	Declares a Report object as a user-defined function parameter that can refer to templated reports.
retrieve	Loads a case from the current position of an external file.
round	Returns a value rounded to the nearest integer.

savepartial	Saves the current case as a partially added, modified, or verified case.
savesetting	Saves, using an attribute-value pair, a setting retrievable with the loadsetting function.
seed	Initializes the random number generator to a particular starting place.
seek	Searches a multiply occurring item for an item that meets a condition.
seekmax	Searches a multiply occurring item for an item with the highest value that meets a condition.
seekmin	Searches a multiply occurring item for an item with the lowest value that meets a condition.
selcase	Allows a data entry operator to select and load a case from an external file.
set	Sets the values of various system parameters.
set access	Sets the order in which cases in a data file are processed.
set attributes	Modifies the field properties in a data entry application.
set behavior	Modifies parameters related to field validation or sets export parameters.
set first	Positions the first case in a data file as the next case to be processed.
set errmsg	Modifies the way that error messages are displayed on desktop CSEntry.
set last	Positions the last case in a data file as the next case to be processed.
setbluetoothname	Sets the name of the device as broadcast to other Bluetooth devices.
setcapturepos	Allows the manual declaration of the window coordinates of the capture type.
setcapturetype	Sets the capture type associated with a field.
setcaselabel	Sets a case's label (the text that appears in a case listing).
setfile	Assigns a new physical file to a dictionary or declared file.
setfont	Changes the default display font in data entry applications.
setlanguage	Modifies the current language being used while in data entry mode.
setlb	Returns the lower bound of the CMC of an event.
setocclabel	Sets the occurrence label associated with a repeating dictionary item or a roster.
setoperatorid	Changes the operator ID associated with the data entry session.
setorientation	Modifies the display orientation, allowing dynamic rotation of the display.
setoutput	Changes the output file where cases are saved in a batch application.
setproperty	Modifies an application or field property.
Settings.getValue ^(CS)	Returns a value from a settings database.
Settings.putValue ^(CS)	Sets a value in a settings database.
setub	Returns the upper bound of the CMC of an event.
setvalue	Assigns a value to a variable whose identity is only known at runtime.
setvalueset	Dynamically modifies the value set of an item.
setvaluesets	Dynamically modifies the value sets for all items in the dictionary.
show	Displays the occurrences of one or more items from a record or multiply occurring item.
showarray	Displays the values of one or more elements from an Array.
showocc	Visually shows (or hides) an occurrence row in a roster.
skip	Jumps forward to a specified field during data entry.
skip case	Ends processing of the current case in a batch edit run.
soccurs	Returns the number of occurrences of a record.
sort	Sorts occurrences of records or items based on the value of an item.
special	Determines whether a variable's value is missing, refused, notappl, or default.
Sqlite.close ^(CS)	Closes a previously opened SQLite database.
Sqlite.exec ^(CS)	Executes a SQL statement on a SQLite database.
Sqlite.open ^(CS)	Opens a SQLite database and returns an ID that can be used for future operations.
Sqlite.rekey ^(CS)	Changes, removes, or adds an encryption key to a SQLite database.
sqlquery	Executes a query on a SQLite database and returns a result set in a variety of formats.
sqrt	Returns the square root of a numeric expression.
startswith	Returns whether a string begins with a specified prefix.
stop	Ends a data entry session or batch edit run.
string	Declares variable-length alphanumeric variables used in the application.
StringWriter	Declares a StringWriter object that supports building strings incrementally.
strip	Removes trailing blanks from a string.
sum	Returns the sum of an item that occurs multiple times.
swap	Switches the order of two occurrences within a group.
syncapp	Updates an application from a new version of the deployed package on a server.
syncconnect	Connects to a CSWeb, Dropbox, or FTP server, or to another device using Bluetooth, to begin a synchronization session.
syncdata	Sends or receives cases between the current device and a server or another device.
syncdisconnect	Ends the current synchronization session.
syncfile	Sends or receives files between the current device and a server or another device.
syncmessage	Sends and receives a string message to a Bluetooth server.
syncparadata	Sends or receives paradata between the current device and a server or another device.
syncserver	Starts running a server on the current device, to which other devices can connect using Bluetooth.
synctime	Returns the time of the last synchronization of a data file or a specific case.
sysdate	Returns the current system date.
sysparm	Returns a parameter a PFF file.
System.createShortcut ^(CS)	Creates a shortcut to a CSPro application or file.
System.getSharableUri ^(CS)	Creates a sharable URI that can be used by external applications to reference a file.
System.selectDocument ^(CS)	Displays a dialog that allows the selection of one or more documents shared by the system.
SystemApp	Declares a SystemApp object for interacting with external applications.
systime	Returns the current system time.

throwException ^(CS)	Throws an exception in the current execution environment.
timestamp	Returns the current UNIX time.
timestring	Returns a custom formatted date and time string.
tolower	Changes all uppercase letters in a string to lowercase.
tonumber	Converts a string to a number.
totocc	Returns the total occurrences for a repeating form, roster, or record.
toupper	Changes all lowercase letters in a string to uppercase.
tr	Translates a string literal into an appropriate string based on the application's current language.
trace	Controls a window or file that can contain debugging information.

UI.alert ^(CS)	Displays an alert dialog.
UI.close ^(CS)	Closes the current HTML dialog or web view, optionally returning a result to an action like UI.showDialog.
UI.enumerateWebViews ^(CS)	Returns information about all of the web views currently showing.
UI.getDisplayOptions ^(CS)	Returns the display options associated with the current web view.
UI.getInputData ^(CS)	Returns the input data associated with the current web view.
UI.getMaxDisplayDimensions ^(CS)	Returns the maximum dimensions, in display units, of HTML dialogs that CSPro can show.
UI.postWebMessage ^(CS)	Posts a message to a web view.
UI.setDisplayOptions ^(CS)	Sets the display options for the current web view.
UI.setWebViewOptions ^(CS)	Sets options, including granting permissions to use resources, for the current web view.
UI.showDialog ^(CS)	Shows a HTML dialog.
UI.view ^(CS)	Views a file or web page in a new web view.
universe	Specifies a condition that must be true for execution of a procedure or function to continue.
userbar	Controls the optional display bar in a data entry application.
uuid	Returns a human-readable string containing a universally unique identifier.

ValueSet	Declares a ValueSet object for storing the contents of a dynamic value set.
view	Launches the system's default viewer to display a file or website.
visualvalue	Returns the visual value of a numeric data item prior to its input.

warning	Displays a "soft check" message only when the operator is not advancing in the case.
when	Executes a statement based on the value of one or more other variables.
while	Executes one or more statements repeatedly while a logical condition remains true.
write	Write to a text file.
writecase	Writes a case from memory to an external file.

See also: List of Reserved Words