ClassesClassesClassesClasses | | | | Operators

clear_templateclear_templateClearTemplateclear_templateClearTemplateClearTemplate (Operator)

Name

clear_templateclear_templateClearTemplateclear_templateClearTemplateClearTemplate — Deallocation of the memory of a template.

Signature

clear_template( : : TemplateID : )

Herror clear_template(const Hlong TemplateID)

Herror T_clear_template(const Htuple TemplateID)

Herror clear_template(const HTuple& TemplateID)

void ClearTemplate(const HTuple& TemplateID)

void HOperatorSetX.ClearTemplate([in] VARIANT TemplateID)

static void HOperatorSet.ClearTemplate(HTuple templateID)

Description

The operator clear_templateclear_templateClearTemplateclear_templateClearTemplateClearTemplate deallocates the memory of a template which has been created by create_templatecreate_templateCreateTemplatecreate_templateCreateTemplateCreateTemplate or create_template_rotcreate_template_rotCreateTemplateRotcreate_template_rotCreateTemplateRotCreateTemplateRot. After execution of the operator clear_templateclear_templateClearTemplateclear_templateClearTemplateClearTemplate the template can no longer be used. The value of TemplateIDTemplateIDTemplateIDTemplateIDTemplateIDtemplateID is not valid. However, the number can be used again by further calls of create_templatecreate_templateCreateTemplatecreate_templateCreateTemplateCreateTemplate or create_template_rotcreate_template_rotCreateTemplateRotcreate_template_rotCreateTemplateRotCreateTemplateRot.

Parallelization

This operator modifies the state of the following input parameter:

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

TemplateIDTemplateIDTemplateIDTemplateIDTemplateIDtemplateID (input_control, state is modified)  template HTemplate, HTupleHTupleHTemplate, HTupleHTemplateX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Template number.

Result

If the number of the template is valid, the operator clear_templateclear_templateClearTemplateclear_templateClearTemplateClearTemplate returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

Possible Predecessors

create_templatecreate_templateCreateTemplatecreate_templateCreateTemplateCreateTemplate, create_template_rotcreate_template_rotCreateTemplateRotcreate_template_rotCreateTemplateRotCreateTemplateRot, read_templateread_templateReadTemplateread_templateReadTemplateReadTemplate, write_templatewrite_templateWriteTemplatewrite_templateWriteTemplateWriteTemplate

Module

Matching


ClassesClassesClassesClasses | | | | Operators