PK_DEBUG_report_start_o_t

struct PK_DEBUG_report_start_o_s
    {
    int             o_t_version;          --- options structure version number
    PK_LOGICAL_t    transmit_parts;       --- whether to transmit parts
                                          --- ( PK_LOGICAL_true )
    PK_LOGICAL_t    output_as_journal;    --- whether to output the report
                                          --- embedded into a journal file
                                          --- ( PK_LOGICAL_false )
    PK_LOGICAL_t    output_binary_parts;  --- whether to embed part files in
                                          --- binary format
                                          --- ( PK_LOGICAL_true )
    PK_DEBUG_output_session_t
                    output_session;       --- whether to include session data
                                          --- in the report
                                          --- ( PK_DEBUG_output_session_no_c )
    PK_DEBUG_report_cb_t
                    report_cb;            --- whether to include debug
                                          --- information for callback
                                          --- functions
                                          --- ( PK_DEBUG_report_cb_no_c )
    };
typedef struct PK_DEBUG_report_start_o_s PK_DEBUG_report_start_o_t;




This structure provides options for the output of debug report information.


Specific Errors:
    PK_ERROR_locked                 including session data in the report but
                                    session contains locked partitions (MILD)

Used in:

PK_DEBUG_report_start

Description of fields:

'transmit_parts'        If PK_LOGICAL_true, then any necessary parts will be
                        saved to the report file, otherwise no parts will be
                        saved.

'output_as_journal'     If PK_LOGICAL_true, then the debug report information
                        will be embedded into a new journal file, otherwise
                        it will be output as a new debug report file.

'output_binary_parts'   If PK_LOGICAL_true, the part files will be embedded
                        into the debug report file in binary format, otherwise
                        they will be output in text format.

'output_session'        If this option is set to
                        PK_DEBUG_output_session_bin_c, then a Parasolid
                        session file in binary format is included in the debug
                        report file. The session file is saved immediately
                        before the first Parasolid function after
                        PK_DEBUG_report_start. You should use this option only
                        when instructed to do so by Parasolid Support.
                        If this option is set to PK_DEBUG_output_session_no_c,
                        then no session file is included in the debug report
                        file. If there are locked partitions in the session
                        then this option must be set to
                        PK_DEBUG_output_session_no_c.

'report_cb'             If this option is set to PK_DEBUG_report_cb_no_c then
                        no debug information for callback functions will be
                        included in the debug report file.  If it is set to
                        PK_DEBUG_report_cb_function_c then debug information
                        for any callback function that is specific to its
                        calling PK function will be included in the debug
                        report file.