ClassesClasses | | Operators

clear_all_sample_identifiersclear_all_sample_identifiersClearAllSampleIdentifiersClearAllSampleIdentifiers (Operator)

Name

clear_all_sample_identifiersclear_all_sample_identifiersClearAllSampleIdentifiersClearAllSampleIdentifiers — Free the memory of all sample identifiers.

Warning

clear_all_sample_identifiersclear_all_sample_identifiersClearAllSampleIdentifiersClearAllSampleIdentifiersClearAllSampleIdentifiers is obsolete and is only provided for reasons of backward compatibility. New applications should not use clear_all_sample_identifiersclear_all_sample_identifiersClearAllSampleIdentifiersClearAllSampleIdentifiersClearAllSampleIdentifiers.

Signature

clear_all_sample_identifiers( : : : )

Herror clear_all_sample_identifiers()

Herror T_clear_all_sample_identifiers()

void ClearAllSampleIdentifiers()

static void HOperatorSet.ClearAllSampleIdentifiers()

Description

The operator clear_all_sample_identifiersclear_all_sample_identifiersClearAllSampleIdentifiersClearAllSampleIdentifiersClearAllSampleIdentifiers frees the memory of all sample identifiers that were created by create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier, read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierReadSampleIdentifier, or deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierDeserializeSampleIdentifier. After calling clear_all_sample_identifiersclear_all_sample_identifiersClearAllSampleIdentifiersClearAllSampleIdentifiersClearAllSampleIdentifiers, no sample identifier can be used any longer.

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

Attention

clear_all_sample_identifiersclear_all_sample_identifiersClearAllSampleIdentifiersClearAllSampleIdentifiersClearAllSampleIdentifiers exists solely for the purpose of implementing the “reset program” functionality in HDevelop. clear_all_sample_identifiersclear_all_sample_identifiersClearAllSampleIdentifiersClearAllSampleIdentifiersClearAllSampleIdentifiers must not be used in any application.

Execution Information

Result

clear_all_sample_identifiersclear_all_sample_identifiersClearAllSampleIdentifiersClearAllSampleIdentifiersClearAllSampleIdentifiers always returns 2 (H_MSG_TRUE).

Module

Matching


ClassesClasses | | Operators