Category Creo Parametric fundamentals, Object ProModelcheck

Function ProModelcheckCheckRegister


Description
Registers an external check that can be included in any ModelCheck execution.
Replacement in Object TOOLKIT: pfcBaseSession::RegisterCustomModelCheck
Synopsis
#include <ProMdlChk.h>
ProErrorProModelcheckCheckRegister(
ProCharName name
/* (In)
The name of the check. This also corresponds to the ModelCheck configuration option name.
*/
wchar_t* label
/* (In)
The label for the check, in the localized language.
*/
ProModelcheckOptions options
/* (In)
Options to be used for the check registration. Can be NULL.
*/
ProModelcheckCheckFunction check_function
/* (In)
The function to be called when executing the check.
*/
ProModelcheckCleanupFunction cleanup_function
/* (In)
The function to be called when ModelCheck is ready to discard the results of the check. Can be NULL.
*/
wchar_t* action_label
/* (In)
Label for the button used to perform an action for an item found by the check. Pass NULL to not provide this button.
*/
ProModelcheckUpdateFunction action_function
/* (In)
The function to be called to perform an action on model based on the results of the check. Can be NULL.
*/
wchar_t* update_label
/* (In)
Label for the button used to update the model for an item found by the check. Pass NULL to not provide this button.
*/
ProModelcheckUpdateFunction update_function
/* (In)
The function to be called when updating the model based on the results of the check. Can be NULL.
*/
ProAppData appdata
/* (In)
Application data to be passed to the callback functions. Can be NULL.
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSOne or more input arguments was invalid.
PRO_TK_E_FOUNDCheck with this name already exists.
PRO_TK_BAD_CONTEXTModelCheck is not enabled in session.

Manual References:

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

Sample Code References:

  1. pt_userguide ( UgModelCheck.c )
  2. pt_userguide ( UgModelCheck.c )
  3. pt_userguide ( UgModelCheck.c )
  4. pt_userguide ( UgModelCheck.c )