Skip to content

get_param_namesGetParamNamesGetParamNamesget_param_namesT_get_param_names🔗

Short description🔗

get_param_namesGetParamNamesGetParamNamesget_param_namesT_get_param_names — Get the names of the parameters of a HALCON-operator.

Signature🔗

get_param_names( proc_name OperatorName, out string InpObjPar, out string OutpObjPar, out string InpCtrlPar, out string OutpCtrlPar )void GetParamNames( const HTuple& OperatorName, HTuple* InpObjPar, HTuple* OutpObjPar, HTuple* InpCtrlPar, HTuple* OutpCtrlPar )static void HOperatorSet.GetParamNames( HTuple operatorName, out HTuple inpObjPar, out HTuple outpObjPar, out HTuple inpCtrlPar, out HTuple outpCtrlPar )def get_param_names( operator_name: str ) -> Tuple[Sequence[str], Sequence[str], Sequence[str], Sequence[str]]

Herror T_get_param_names( const Htuple OperatorName, Htuple* InpObjPar, Htuple* OutpObjPar, Htuple* InpCtrlPar, Htuple* OutpCtrlPar )

static HTuple HInfo::GetParamNames( const HString& OperatorName, HTuple* OutpObjPar, HTuple* InpCtrlPar, HTuple* OutpCtrlPar )

static HTuple HInfo::GetParamNames( const char* OperatorName, HTuple* OutpObjPar, HTuple* InpCtrlPar, HTuple* OutpCtrlPar )

static HTuple HInfo::GetParamNames( const wchar_t* OperatorName, HTuple* OutpObjPar, HTuple* InpCtrlPar, HTuple* OutpCtrlPar ) (Windows only)

static HTuple HInfo.GetParamNames( string operatorName, out HTuple outpObjPar, out HTuple inpCtrlPar, out HTuple outpCtrlPar )

Description🔗

For the HALCON-operator indicated in OperatorNameoperatorNameoperator_name the operator get_param_namesGetParamNames returns the names of the input objects, the output objects, of the input control parameters and the output control parameters.

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters🔗

OperatorNameoperatorNameoperator_name (input_control) proc_name → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the operator.

Default: 'get_param_names'"get_param_names"

InpObjParinpObjParinp_obj_par (output_control) string-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Names of the input objects.

OutpObjParoutpObjParoutp_obj_par (output_control) string-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Names of the output objects.

InpCtrlParinpCtrlParinp_ctrl_par (output_control) string-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Names of the input control parameters.

OutpCtrlParoutpCtrlParoutp_ctrl_par (output_control) string-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Names of the output control parameters.

Result🔗

The operator get_param_namesGetParamNames returns the value 2 (H_MSG_TRUE) if the name of the operator exists and the helpfiles are available. Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

get_keywordsGetKeywords, search_operatorSearchOperator, get_operator_nameGetOperatorName, get_operator_infoGetOperatorInfo

Possible successors

get_param_numGetParamNum, get_param_typesGetParamTypes

Alternatives

get_operator_infoGetOperatorInfo, get_param_infoGetParamInfo

See also

get_param_numGetParamNum, get_param_typesGetParamTypes, get_operator_nameGetOperatorName

Module🔗

Foundation