PK_PARTITION_transmit   


PK_ERROR_code_t    PK_PARTITION_transmit
(
--- received arguments ---
PK_PARTITION_t                   partition,   --- partition
const char                      *key,         --- key string
const PK_PARTITION_transmit_o_t *options      --- transmit options
)


This function transmits the given partition to the give 'file' key.


Specific Errors:
    PK_ERROR_rollback_not_started  Partitioned rollback is not active
    PK_ERROR_not_at_pmark          Partition is not at a pmark
    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 partition 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
partition to.

The frustrum routine FFOPWR is called with guise FFCXMP (transmit file
containing a partition). If the option to also transmit deltas is selected,
then the the pmarks and deltas are written to a separate file, with the same
key, which is opened with guise FFCXMD (transmit file containing deltas). In
this case, the partition must be at a pmark.

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)