get_handle_paramT_get_handle_paramGetHandleParamGetHandleParamget_handle_param (Operator)
Name
get_handle_paramT_get_handle_paramGetHandleParamGetHandleParamget_handle_param — Zurückgeben von Informationen über ein Handle.
Signatur
def get_handle_param(handle: HHandle, gen_param_name: str, key: MaybeSequence[str]) -> Sequence[Union[int, float, str]]
def get_handle_param_s(handle: HHandle, gen_param_name: str, key: MaybeSequence[str]) -> Union[int, float, str]
Beschreibung
get_handle_paramget_handle_paramGetHandleParamGetHandleParamGetHandleParamget_handle_param gibt Informationen über HandleHandleHandleHandlehandlehandle
zurück.
Der Operator bietet einen generischen Mechanismus, um den Inhalt von
Handles aller Typen zu debuggen. Er liefert insbesondere eine Liste von
Schlüsseln für das Handle zurück, zu denen Werte mittels
get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTupleget_handle_tuple und get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObjectget_handle_object abgefragt werden können.
Zu beachten ist, dass get_handle_paramget_handle_paramGetHandleParamGetHandleParamGetHandleParamget_handle_param nur für die Implementierung
generischer Inspektions- und Debugmechanismen gedacht ist.
Die für ein Handle zurückgegebenen Schlüssel können sich auch ohne weitere
Ankündigung ändern.
Weiterhin werden manche Handletypen und Handleeigenschaften von diesem
Mechanismus eventuell nicht unterstützt.
Dieser Mechanismus ist nicht auf Performanz optimiert.
Um die Eigenschaften von Handles zuverlässig abzufragen, etwa zum
Steuern des weiteren Programmablaufs, wird empfohlen, die jeweils
auf einen Handletyp spezialisierten Operatoren wie
get_object_model_3d_paramsget_object_model_3d_paramsGetObjectModel3dParamsGetObjectModel3dParamsGetObjectModel3dParamsget_object_model_3d_params oder get_generic_shape_model_paramget_generic_shape_model_paramGetGenericShapeModelParamGetGenericShapeModelParamGetGenericShapeModelParamget_generic_shape_model_param
zu verwenden.
Je nach dem Wert von GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name können mit diesem Operator die
folgenden Eigenschaften abgefragt werden:
- 'keys'"keys""keys""keys""keys""keys":
-
Gibt in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value eine Liste von Schlüsseln zurück, die
vom übergebenen Handle unterstützt werden.
Jeder Schlüssel enthält entweder ein ikonisches Objekt oder ein Tupel.
Für diese Abfrage muss der Parameter KeyKeyKeyKeykeykey auf ein leeres Tupel
gesetzt werden.
Aufgrund des generischen Mechanismus dieses Operators sind einige der
zurückgegebenen Schlüssel für das übergebene Handle möglicherweise
nicht gültig.
Für solche Schlüssel liefern get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTupleget_handle_tuple bzw.
get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObjectget_handle_object einen Fehler zurück.
- 'key_data_type'"key_data_type""key_data_type""key_data_type""key_data_type""key_data_type":
Gibt den Datentyp des in KeyKeyKeyKeykeykey übergebenen Schlüssels zurück.
Der Typ wird in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value zurückgegeben und ist entweder
'tuple'"tuple""tuple""tuple""tuple""tuple" oder 'object'"object""object""object""object""object".
Je nach Typ kann der dem Schlüssel zugewiesene Wert mit
get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTupleget_handle_tuple oder get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObjectget_handle_object abgerufen werden.
Ausführungsinformationen
- Multithreading-Typ: reentrant (läuft parallel zu nicht-exklusiven Operatoren).
- Multithreading-Bereich: global (kann von jedem Thread aufgerufen werden).
- Wird ohne Parallelisierung verarbeitet.
Parameter
HandleHandleHandleHandlehandlehandle (input_control) handle → HHandle, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle, dessen Eigenschaft abgerufen werden soll.
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Abzurufende Eigenschaft.
Defaultwert:
'keys'
"keys"
"keys"
"keys"
"keys"
"keys"
Werteliste: 'key_data_type'"key_data_type""key_data_type""key_data_type""key_data_type""key_data_type", 'keys'"keys""keys""keys""keys""keys"
KeyKeyKeyKeykeykey (input_control) string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Optionaler Schlüssel, dessen Eigenschaften abgerufen werden.
Defaultwert: []
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control) tuple(-array) → HTupleSequence[Union[int, float, str]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)
Zurückgegebener Wert.
Ergebnis
Sind die Parameterwerte korrekt, dann liefert
get_handle_paramget_handle_paramGetHandleParamGetHandleParamGetHandleParamget_handle_param den Wert 2 (H_MSG_TRUE).
Gegebenenfalls wird eine Fehlerbehandlung durchgeführt.
Nachfolger
clear_handleclear_handleClearHandleClearHandleClearHandleclear_handle,
get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTupleget_handle_tuple,
get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObjectget_handle_object
Siehe auch
get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTupleget_handle_tuple,
get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObjectget_handle_object
Modul
Foundation