The four functions shown here are used to get the movement of choice from the user and retrieve all the details. In the programming code examples, supplied with the package, language specific alternatives to these are supplied using the native programming language formats for strings and other classes of properties. Those functions are called:
UserChooses (equivalent to PickMovement)
GetProperties (equivalent to GetDetails)
SaveMovement (equivalent to ExportMovement)
Note: all programmer functions use the file number as the main reference to a movement file, the number being unique within the current library.
The programmer can call this function to obtain the user's choice of movement. This function displays a windows screen from which the user can choose a movement from a list, narrowing their choices based on the parameters they supply. Their choice is returned to the programmer as file number within the library of their choice.
Before calling this function the programmer can predefine many of the properties or simply leave it up to the user to narrow their choice. Those properties that can be supplied are: Movement Class, Movement Type, Players, Rounds, Number of winners, Boards Per Set and Library Name. If these properties are not chosen carefully the first list presented to the user may be empty.
This function returns true if the user has selected a movement otherwise it will be false.
The GetDetails function returns all the properties of the movement requested. The request supplies the library name and the file number. If successful it returns true otherwise false. The details are retrieved from the movement file in contrast to the GetDisplay function shown below.
The GetDisplay function delivers a limited number of the properties of the movement requested. The request supplies the library name and the file number. If successful it returns true otherwise false. The details are retrieved from the index file rather than from movement file in contrast to the GetDetails function shown above.
GetDisplay is used when retrieving the basic properties for display of a list of movements. This is used so that the performance is not compromised when looking at a large list of movements.
The ExportMovement function allows the programmer to save to a text file, of chosen format, the movement of choice. The programmer supplies the library, file number and the name and location of the file where the text is to be written. The format (scorer type) is also specified.