clear_templateT_clear_templateClearTemplateClearTemplate (Operator)
Name
clear_templateT_clear_templateClearTemplateClearTemplate — Deallocation of the memory of a template.
Warning
clear_templateclear_templateClearTemplateClearTemplateClearTemplate is obsolete and is only provided for
reasons of backward compatibility. New applications should use the
shape-based or NCC-based operators instead.
Signature
Description
The operator clear_templateclear_templateClearTemplateClearTemplateClearTemplate deallocates the memory of
a template which has been created by create_templatecreate_templateCreateTemplateCreateTemplateCreateTemplate
or create_template_rotcreate_template_rotCreateTemplateRotCreateTemplateRotCreateTemplateRot.
After execution of the operator clear_templateclear_templateClearTemplateClearTemplateClearTemplate
the template can no longer be used. The value
of TemplateIDTemplateIDTemplateIDTemplateIDtemplateID is not valid.
However, the number can be used again by further calls of
create_templatecreate_templateCreateTemplateCreateTemplateCreateTemplate or create_template_rotcreate_template_rotCreateTemplateRotCreateTemplateRotCreateTemplateRot.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without 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
TemplateIDTemplateIDTemplateIDTemplateIDtemplateID (input_control, state is modified) template → HTemplate, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Template number.
Result
If the number of the template is valid, the operator
clear_templateclear_templateClearTemplateClearTemplateClearTemplate returns the value 2 (H_MSG_TRUE).
If necessary an exception is raised.
Possible Predecessors
create_templatecreate_templateCreateTemplateCreateTemplateCreateTemplate,
create_template_rotcreate_template_rotCreateTemplateRotCreateTemplateRotCreateTemplateRot,
read_templateread_templateReadTemplateReadTemplateReadTemplate,
write_templatewrite_templateWriteTemplateWriteTemplateWriteTemplate
Module
Matching