SSO_INIT()
Initialises SSO'137 internal common block - should be run at beginning of application.
SSO_CLOSE()
Unmaps, annuls and resets everything leaving common blocks in a respectable state for following applications (in a monolith).
SSO_ASSOCI( PAR, MODE; LOC, SET, STATUS )
PAR <char> The ADAM parameter name to associate
MODE <char> Access mode, READ or UPDATE
LOC <char> Locator to SSDS container structure
SET <log> true if SSDS is a set
Associates an SSDS file with the ADAM parameter PAR, using access MODE. If input is not an SSDS, status is set bad.
SSO_RELEASE( LOC, STATUS )
LOC <char> Locator to SSDS container structure
Frees all internal SSO storage and frees mapped field data.
SSO_VALID( LOC; OK, STATUS )
LOC <char> Locator to SSDS container structure
OK <log> True if LOC is a valid SSDS
Test whether LOC is a valid SSDS
SSO_CHKBOOK( LOC; OK, NFILE, STATUS )
LOC <char> Locator to SSDS container structure
OK <log> BOOK data exists?
NFILE <int> Number of book components
SSO_CHKFLD( LOC, FLD; OK, STATUS )
LOC <char> Locator to SSDS container structure
FLD <char> The name of the field
OK <log> Field data exists?
Checks the existence of the named field's data
SSO_CHKFLDERR( LOC, FLD; OK, STATUS )
LOC <char> Locator to SSDS container structure
FLD <char> The name of the field
OK <log> Field error exists?
Checks the existence of the named field's error
SSO_CHKFITEM( LOC, FLD, ITEM; OK, STATUS )
LOC <char> Locator to SSDS container structure
FLD <char> The name of the field
ITEM <char> The name of the field item
OK <log> Field's item exists?
Checks the existence of the named field item
SSO_LOCBOOK( LOC; FILE, BLOC, STATUS )
LOC <char> Locator to SSDS container structure
FILE <int> Book component number
BLOC <char> Locator to book component
Locate the FILE'th component of the BOOK structure in the specified SSDS
SSO_LOCFLD( LOC, FLD; FLOC, STATUS )
LOC <char> Locator to SSDS container structure
FLD <char> The name of the field
FLOC <char> Locator to named field
Returns locator to the structured field component - note not the field data component.
SSO_MAPFLD( LOC, FLD, TYPE, MODE; PTR, STATUS )
LOC <char> Locator to SSDS container structure
FLD <char> The name of the field
TYPE <char> The type to use in mapping
MODE <char> Access mode, READ, WRITE or UPDATE
PTR <int> The pointer to the mapped data
Maps the the field data of the field FLD using the specified TYPE.
SSO_MAPFLDERR( LOC, FLD, TYPE, MODE; PTR, STATUS )
LOC <char> Locator to SSDS container structure
FLD <char> The name of the field
TYPE <char> The type to use in mapping
MODE <char> Access mode, READ, WRITE or UPDATE
PTR <int> The pointer to the mapped data
Maps the the field error data of the field FLD using the specified TYPE.
SSO_UNMAPFLD( LOC, FLD, STATUS )
LOC <char> Locator to SSDS container structure
FLD <char> The name of the field
Unmap the named field data
SSO_UNMAPFLDERR( LOC, FLD, STATUS )
LOC <char> Locator to SSDS container structure
FLD <char> The name of the field
Unmap the named field error
SSO_GETNSRC( LOC; NSRC, STATUS )
LOC <char> Locator to SSDS container structure
NSRC <int> Number of records
Returns number of record in the SSDS
SSO_GETFITEM0<T>( LOC, FLD, ITEM; VALUE, STATUS )
LOC <char> Locator to SSDS container structure
FLD <char> The name of the field
ITEM <char> The field item name
VALUE <TYPE> The field item value
Retrieves the value of the named scalar field item. The routine exists in 0C,0I,0R,0D and 0L forms.
SSO_GETFITEM1<T>( LOC, FLD, ITEM, MAXVAL; VALUE, ACTVAL, STATUS )
LOC <char> Locator to SSDS container structure
FLD <char> The name of the field
ITEM <char> The field item name
MAXVAL <int> The maximum number of values to be read
VALUE <TYPE> The field item value
ACTVAL <int> The actual number of values read
Retrieves the value of the named vector field item. The routine exists in 0C,0I,0R,0D and 0L forms.
SSO_GETPAR0<T>( LOC, FILE, PAR; VALUE, STATUS )
LOC <char> Locator to SSDS container structure
FILE <int> File number
PAR <char> The parameter name
VALUE <TYPE> The field item value
Retrieves the value of the named scalar parameter. The routine exists in 0C,0I,0R,0D and 0L forms.
SSO_GETPAR1<T>( LOC, FILE, PAR, MAXVAL; VALUE, ACTVAL, STATUS )
LOC <char> Locator to SSDS container structure
FILE <int> File number
PAR <char> The parameter name
MAXVAL <int> The maximum number of values to be read
VALUE <TYPE> The field item value
ACTVAL <int> The actual number of values read
Retrieves the value of the named vector parameter. The routine exists in 0C,0I,0R,0D and 0L forms.
SSO_PUTNSRC( LOC, NSRC, STATUS )
LOC <char> Locator to SSDS container structure
NSRC <int> Number of records
Sets the number of record in the SSDS. Note that this routine must be executed before any CREFLD or CREFLDERR calls.
SSO_PUTFITEM0C( LOC, FLD, ITEM, LEN; VALUE, STATUS )
LOC <char> Locator to SSDS container structure
FLD <char> The name of the field
ITEM <char> The field item name
LEN <int> The length of the character component
to be created, ie. _CHAR*<len>
VALUE <char> The field item value
Writes the value of the named CHARACTER field item.
SSO_PUTFITEM1<T'>( LOC, FLD, ITEM; NVAL, VALUE, STATUS )
LOC <char> Locator to SSDS container structure
FLD <char> The name of the field
ITEM <char> The field item name
NVAL <int> Number of values
VALUE <TYPE> The field item value
Writes the value of the named vector field item.
SSO_PUTPAR0C( LOC, FILE, PAR, LEN; VALUE, STATUS )
LOC <char> Locator to SSDS container structure
FILE <int> File number
PAR <char> The name of the parameter
LEN <int> The length of the character component
to be created, ie. _CHAR*<len>
VALUE <char> The field item value
Writes the value of the named CHARACTER scalar parameter.
SSO_PUTPAR0<T'>( LOC, FILE, PAR; VALUE, STATUS )
LOC <char> Locator to SSDS container structure
FILE <int> File number
PAR <char> The name of the parameter
VALUE <TYPE> The field item value
Writes the value of the named scalar parameter. The routine exists in 0I,0R,0D and 0L forms.
SSO_PUTPAR1<T'>( LOC, FILE, PAR; NVAL, VALUE, STATUS )
LOC <char> Locator to SSDS container structure
FILE <int> File number
PAR <char> The name of the parameter
NVAL <int> Number of values
VALUE <TYPE> The field item value
Writes the value of the named vector parameter.
SSO_CREBOOK( LOC, NFILE, STATUS )
LOC <char> Locator to SSDS container structure
NFILE <int> Number of book components
Create a new BOOK structure with NFILE components
SSO_CREFLD( LOC, FLD, TYPE, STATUS )
LOC <char> Locator to SSDS container structure
FLD <char> The name of the field
TYPE <char> The type of the field
Create new field. Any existing field with the same name is deleted first.
SSO_CREFLDERR( LOC, FLD, TYPE, NDAT, NFLD, STATUS )
LOC <char> Locator to SSDS container structure
FLD <char> The name of the field
TYPE <char> The type of the field
NDAT <int> Number of data items per error level
NLEV <int> Number of error levels
Create new field error. Any existing field with the same name is deleted first.