 |
PK_BODY_sweep_tool_r_t |
|
struct PK_BODY_sweep_tool_r_s
{
PK_BODY_sweep_tool_status_r_t status;
PK_BODY_t body;
};
typedef struct PK_BODY_sweep_tool_r_s PK_BODY_sweep_tool_r_t;
A structure packaging a single swept result body along with its associated
status.
Used in:
PK_BODY_make_swept_tool
PK_BODY_sweep_tool_r_f
The structure has the following fields :
'status' A structure containing the degree of success in completing
the swept body and information on any faults detected.
Note that this may indicate failure even where
PK_BODY_make_swept_tool returns PK_ERROR_no_errors.
'body' The swept body produced by PK_BODY_make_swept_tool.
It may not check or be valid in cases where the status
indicates anything other than complete success.
The function PK_BODY_sweep_tool_r_f may be used to free associated memory.