PK_SESSION_transmit

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 given 'file' 'key'.


Specific Errors:
    PK_ERROR_bad_key               Frustrum (FFOPWR) returned FR_bad_name
                                     (MILD)
    PK_ERROR_key_in_use            Frustrum (FFOPWR) returned FR_already_exists
                                     (MILD)
    PK_ERROR_cant_open_file        Frustrum (FFOPWR) returned FR_open_fail
                                     (MILD)
    PK_ERROR_schema_access_error   Error opening, closing, or writing the
                                       schema file (MILD)
    PK_ERROR_file_access_error     Error writing or closing the transmit file
                                     (MILD)
    PK_ERROR_disc_full             Frustrum (FFWRIT) returned FR_disc_full
                                     (MILD)
    PK_ERROR_applio_not_registered Application i/o functions not registered
                                     (only relevant if options->transmit_format
                                      is PK_transmit_format_applio_c) (MILD)
    PK_ERROR_bad_text_conversion   Some part data could not be written
                                     (only relevant if options->transmit_format
                                      is PK_transmit_format_text_c) (MILD)
    PK_ERROR_rollback_not_started  Partitioned rollback is not active
                                     (only relevant if options->transmit_deltas
                                      is PK_PARTITION_xmt_deltas_all_c) (MILD)
    PK_ERROR_not_at_pmark          Partition is not at a pmark
                                     (only relevant if options->transmit_deltas
                                      is PK_PARTITION_xmt_deltas_all_c) (MILD)
    PK_ERROR_not_at_rollmark       Modeller is not at a session mark
                                     (only relevant if options->transmit_marks
                                      is PK_SESSION_xmt_marks_all_c) (MILD)
    PK_ERROR_locked                Session contains locked partitions (MILD)


The 'key' is passed to the frustrum, identifying to which 'file' the session
will be transmitted.

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 session marks are optional. No missing delayed-load model data
is loaded during a session transmit. Partial pmarks are allowed to be
transmitted during session transmit, however, data connections of
delayed-load model data will be lost. 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)

Note: You are advised to consult with Parasolid Support before using
partial pmarks.