deserialize_sample_identifierT_deserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifier (Operator)

Name

deserialize_sample_identifierT_deserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifier — Deserialize a serialized sample identifier.

Signature

deserialize_sample_identifier( : : SerializedItemHandle : SampleIdentifier)

Herror T_deserialize_sample_identifier(const Htuple SerializedItemHandle, Htuple* SampleIdentifier)

void DeserializeSampleIdentifier(const HTuple& SerializedItemHandle, HTuple* SampleIdentifier)

void HSampleIdentifier::DeserializeSampleIdentifier(const HSerializedItem& SerializedItemHandle)

static void HOperatorSet.DeserializeSampleIdentifier(HTuple serializedItemHandle, out HTuple sampleIdentifier)

void HSampleIdentifier.DeserializeSampleIdentifier(HSerializedItem serializedItemHandle)

Description

deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierDeserializeSampleIdentifier deserializes a sample identifier that was serialized by serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifierSerializeSampleIdentifier (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItem for an introduction of the basic principle of serialization). The serialized sample identifier is defined by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle. The deserialized values are stored in an automatically created sample identifier with the handle SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier.

For an explanation of the concept of sample-based identification see the introduction of chapter Identification / Sample-Based.

Execution Information

Parameters

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (input_control)  serialized_item HSerializedItem, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the serialized item.

SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier (output_control)  sample_identifier HSampleIdentifier, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the sample identifier.

Result

If the parameters are valid, the operator deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierDeserializeSampleIdentifier returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Successors

apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierApplySampleIdentifier, add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData

Alternatives

read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierReadSampleIdentifier

See also

create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier, add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationData, prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifierPrepareSampleIdentifier, train_sample_identifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifierTrainSampleIdentifier, set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParamSetSampleIdentifierParam, get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParamGetSampleIdentifierParam, get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo, remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationData, remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingData, write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierWriteSampleIdentifier, serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifierSerializeSampleIdentifier, clear_sample_identifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifierClearSampleIdentifier, set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo

Module

Matching