get_handle_paramT_get_handle_paramGetHandleParamGetHandleParam (Operator)

Name

get_handle_paramT_get_handle_paramGetHandleParamGetHandleParam — Zurückgeben von Informationen über ein Handle.

Signatur

get_handle_param( : : Handle, GenParamName, Key : GenParamValue)

Herror T_get_handle_param(const Htuple Handle, const Htuple GenParamName, const Htuple Key, Htuple* GenParamValue)

void GetHandleParam(const HTuple& Handle, const HTuple& GenParamName, const HTuple& Key, HTuple* GenParamValue)

static void HOperatorSet.GetHandleParam(HTuple handle, HTuple genParamName, HTuple key, out HTuple genParamValue)

Beschreibung

get_handle_paramget_handle_paramGetHandleParamGetHandleParamGetHandleParam gibt Informationen über HandleHandleHandleHandlehandle zurück. Der Operator bietet einen generischen Mechanismus, um den Inhalt von Handles aller Typen zu debuggen. Er liefert insbesonderes eine Liste von Schlüsseln für das Handle zurück, zu denen Werte mittels get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTuple und get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObject abgefragt werden können.

Zu beachten ist, dass get_handle_paramget_handle_paramGetHandleParamGetHandleParamGetHandleParam 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_paramsGetObjectModel3dParamsGetObjectModel3dParamsGetObjectModel3dParams oder get_shape_model_paramsget_shape_model_paramsGetShapeModelParamsGetShapeModelParamsGetShapeModelParams zu verwenden.

Je nach dem Wert von GenParamNameGenParamNameGenParamNameGenParamNamegenParamName können mit diesem Operator die folgenden Eigenschaften abgefragt werden:

'keys'"keys""keys""keys""keys":

Gibt in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue 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 KeyKeyKeyKeykey 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_tupleGetHandleTupleGetHandleTupleGetHandleTuple bzw. get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObject einen Fehler zurück.

'key_data_type'"key_data_type""key_data_type""key_data_type""key_data_type":

Gibt den Datentyp des in KeyKeyKeyKeykey übergebenen Schlüssels zurück. Der Typ wird in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue zurückgegeben und ist entweder 'tuple'"tuple""tuple""tuple""tuple" oder 'object'"object""object""object""object". Je nach Typ kann der dem Schlüssel zugewiesene Wert mit get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTuple oder get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObject abgerufen werden.

Ausführungsinformationen

Parameter

HandleHandleHandleHandlehandle (input_control)  handle HHandle, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle, dessen Eigenschaft abgerufen werden soll.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control)  string HTupleHTupleHtuple (string) (string) (HString) (char*)

Abzurufende Eigenschaft.

Defaultwert: 'keys' "keys" "keys" "keys" "keys"

Werteliste: 'key_data_type'"key_data_type""key_data_type""key_data_type""key_data_type", 'keys'"keys""keys""keys""keys"

KeyKeyKeyKeykey (input_control)  string(-array) HTupleHTupleHtuple (string) (string) (HString) (char*)

Optionaler Schlüssel, dessen Eigenschaften abgerufen werden.

Defaultwert: []

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (output_control)  tuple(-array) HTupleHTupleHtuple (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_paramGetHandleParamGetHandleParamGetHandleParam den Wert 2 (H_MSG_TRUE). Gegebenenfalls wird eine Fehlerbehandlung durchgeführt.

Nachfolger

clear_handleclear_handleClearHandleClearHandleClearHandle, get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTuple, get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObject

Siehe auch

get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTuple, get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObject

Modul

Foundation