clear_templateT_clear_templateClearTemplateClearTemplateclear_template (Operator)
Name
clear_templateT_clear_templateClearTemplateClearTemplateclear_template — Deallocation of the memory of a template.
Warning
clear_templateclear_templateClearTemplateClearTemplateClearTemplateclear_template 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_templateClearTemplateClearTemplateClearTemplateclear_template deallocates the memory of
a template which has been created by create_templatecreate_templateCreateTemplateCreateTemplateCreateTemplatecreate_template
or create_template_rotcreate_template_rotCreateTemplateRotCreateTemplateRotCreateTemplateRotcreate_template_rot.
After execution of the operator clear_templateclear_templateClearTemplateClearTemplateClearTemplateclear_template
the template can no longer be used. The value
of TemplateIDTemplateIDTemplateIDTemplateIDtemplateIDtemplate_id is not valid.
However, the number can be used again by further calls of
create_templatecreate_templateCreateTemplateCreateTemplateCreateTemplatecreate_template or create_template_rotcreate_template_rotCreateTemplateRotCreateTemplateRotCreateTemplateRotcreate_template_rot.
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:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters
TemplateIDTemplateIDTemplateIDTemplateIDtemplateIDtemplate_id (input_control, state is modified) template → HTemplate, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Template number.
Result
If the number of the template is valid, the operator
clear_templateclear_templateClearTemplateClearTemplateClearTemplateclear_template returns the value TRUE.
If necessary an exception is raised.
Possible Predecessors
create_templatecreate_templateCreateTemplateCreateTemplateCreateTemplatecreate_template,
create_template_rotcreate_template_rotCreateTemplateRotCreateTemplateRotCreateTemplateRotcreate_template_rot,
read_templateread_templateReadTemplateReadTemplateReadTemplateread_template,
write_templatewrite_templateWriteTemplateWriteTemplateWriteTemplatewrite_template
Module
Matching