Layout for function descriptions
All functions mentioned in this chapter are described under the following set of headings:
- Function name
- The description of each routine starts on a new page for the sake of clarity.
- Purpose
- A short description of the routine and its purpose begins the information section.
- Synopsis
- A synopsis of the syntax for usage of the routine is provided. 'Optional' arguments and flags may be specified as NULL if not required. Where this possibility exists, it will be described alongside the argument, or in the Further Information at the end of the routine's description.
- Arguments
- A list of arguments to the routine with a description of possible values for them follows.
- Return value
- A list of possible return values and their meaning.
- Examples
- One or two examples are provided which explain certain aspects of the routine's use.
- Further information
- Additional information not contained elsewhere in the routine's description is provided at the end.
- Related topics
- Finally a list of related routines and topics is provided for comparison and reference.
© 2001-2019 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.