PK_ERROR_code_t PK_SESSION_transmit
(
--- received arguments ---
const char *key, --- key string
const PK_SESSION_transmit_o_t *options --- transmit options
)
This function transmits the session to the give 'file' key.
Specific Errors:
PK_ERROR_bad_key Frustrum (FFOPWR) returned FR_bad_name
PK_ERROR_key_in_use Frustrum (FFOPWR) returned FR_already_exists
PK_ERROR_cant_open_file Frustrum (FFOPWR) returned FR_open_fail
PK_ERROR_schema_access_error Error opening, closing, or writing the
schema file
PK_ERROR_file_access_error Error writing or closing the transmit file
PK_ERROR_disc_full Frustrum (FFWRIT) returned FR_disc_full
PK_ERROR_applio_not_registered Application i/o functions not registered
(only relevant if options->transmit_format
is PK_transmit_format_applio_c)
PK_ERROR_bad_text_conversion Some part data could not be written
(only relevant if options->transmit_format
is PK_transmit_format_text_c)
The key is passed to the frustrum to identify the 'file' used to transmit the
session to.
The frustrum routine FFOPWR is called with guise FFCSNP ('snapshot' file
containing session).
The partitions in the session, and their contents, are transmitted; but the
pmarks and deltas are not. The state of the bulletin board, attribute
definitions and interface and modelling parameters are also saved in the file.
The transmit format option affects the format argument to FFOPWR as follows:
transmit format format
PK_transmit_format_text_c FFTEXT
PK_transmit_format_binary_c FFBNRY
PK_transmit_format_neutral_c FFBNRY
PK_transmit_format_applio_c (registered function is called, not FFOPWR -
see PK_SESSION_register_applio)