Category Creo Parametric fundamentals, Object ProModelcheck

Callback ProModelcheckCheckFunction


Description
This is the callback that is called to evaluate a ModelCheck externally defined check.
Synopsis
#include <ProMdlChk.h>
ProError(*ProModelcheckCheckFunction)(
ProCharName name
/* (In)
The name of the check. This also corresponds to the ModelCheck configuration option name.
*/
ProMdl mdl
/* (In)
The model being checked during this run.
*/
ProAppData appdata
/* (In)
Application data that was registered for the check.
*/
int* results_count
/* (Out)
Numerical count to be shown in the ModelCheck report for this check.
*/
wchar_t** results_url
/* (Out)
URL to a page that provides details on the results of this check. Can be NULL, in which case the check will be listed with no extra information besides the count. Memory for this argument should be allocated and maintained by the application. It can be freed from the cleanup action for the ModelCheck check.
*/
wchar_t*** results_table
/* (Out)
A ProArray of strings to show for details of each found item. Can be NULL. The memory for this argument should be allocated and maintained in the application. It can be freed in the cleanup action for the ModelCheck check.
*/
)
Returns
PRO_TK_NO_ERRORThe check succeeded with no errors found.
PRO_TK_E_FOUNDThe check succeeded and errors were found.
Any other valueUnable to perform the check.

Manual References:

  1. Core: Utilities: Creating Custom Checks
  2. Core: Utilities: Creating Custom Checks