Vtk_CtxtOptionDeleteContent
Toolkit Reference

prevnext

Vtk_CtxtOptionDeleteContent

#include <vtk_ctxt.h>
#include <vtk_err.h>
Vtk_uint32 Vtk_CtxtOptionDeleteContent(
Vtk_CtxtOption *data
);

Description

This Toolkit context function releases memory previously allocated to the Vtk_CtxtOption structure with the Vtk_CtxtGetOption function. Once this function completes successfully, the Vtk_CtxtOption structure becomes invalid. Other resources allocated to the structure are not released.

Parameters

data Pointer to the Vtk_CtxtOption structure for which memory and resources are to be released.

Return Value

VTK_OK The function has completed successfully and the context option structure has been deleted.
error code The function has failed. For information about possible error values, refer to Appendix 

Notes

Only the context option data contained within the structure is released. The application must call this function for each context option structure returned from the Vtk_CtxtGetOption function. If the application does not call Vtk_CtxtOptionDeleteContent, memory leaks and other problems can occur. For more information about the Toolkit memory model, see Toolkit Memory Model.


See Also

Vtk_CtxtGetOption

prevnext


ValiCert, Inc.
http://www.valicert.com
Voice: +1.650.567.5469
Fax: (+1.650.254.2148
support@valicert.com