Category Parameters and relations, Object ProParameter

Function ProParameterSelect


Description
Prompts the user to select one or more parameters from the parameter dialog in Creo Parametric.

Note: The top model from which the parameters will be selected must be displayed in the current window.

Replacement in Object TOOLKIT: pfcParameterOwner::SelectParam
pfcParameterOwner::SelectParameters
Synopsis
#include <ProParameter.h>
ProErrorProParameterSelect(
ProModelitem* owner
/* (In)
The owner of the parameters to be selected. May be NULL if the parameter should be selected by context.
*/
ProMdl top_model
/* (In)
The top level model from which parameters will be selected.
*/
int context
/* (In)
A bitmask containing the context of parameter selection (Members of ProParameterSelectContext). Used only if "owner" is NULL.
*/
ProBoolean select_multiple
/* (In)
PRO_B_TRUE to allow multiple selections. PRO_B_FALSE otherwise.
*/
wchar_t* button_label
/* (In)
Label for select button, or NULL to use default label.
*/
ProParameter* parameter
/* (Out)
If select_multiple is PRO_B_FALSE should contain the selected parameter. NULL should be passed if select_multiple is PRO_B_TRUE.
*/
ProParameter** multi_parameters
/* (Out)
If select_multiple is PRO_B_TRUE should contain ProArray of selected parameters. ProArrayFree should be used to free this array.. NULL passed if select_multiple is PRO_B_FALSE.
*/
)
Returns
PRO_TK_NO_ERRORThe user selected the parameter(s).
PRO_TK_BAD_CONTEXTThe owner is invalid or not found.
PRO_TK_E_NOT_FOUNDThe owner does not contain parameteers.
PRO_TK_USER_ABORTThe user aborted the selection.
PRO_TK_INVALID_TYPEInvalid context for top_model argument.
PRO_TK_BAD_INPUTSOne or more arguments was invalid.

Manual References:

  1. Core: Family Tables: Operations on Family Table Items
  2. Core: Parameters: Accessing Parameters
  3. Core: Parameters: Accessing Parameters

Sample Code References:

  1. pt_examples ( TestFamTab.c )
  2. pt_examples ( TestParams.c )
  3. pt_examples ( TestParams.c )
  4. pt_examples ( TestParams.c )
  5. pt_examples ( TestSelect.c )