Vtk_CtxtGetOption
Toolkit Reference

prevnext

Vtk_CtxtGetOption

#include <vtk_ctxt.h>
#include <vtk_err.h>
Vtk_uint32 Vtk_CtxtGetOption(
const Vtk_Ctxt* ctxt, /* input */
Vtk_CtxtOption *outData /* output */
);

Description

This Toolkit context function returns current context option information for the specified context. The size of the structure varies with the type of information currently set for the context.

For a comprehensive list of the supported context option types, see Vtk_CtxtLogType.

Parameters

ctxt Pointer to Toolkit context created using the Vtk_CtxtNew function and for which memory has been allocated. The structure for which this function gets the option information.
outData Option information returned. The information depends on the option type currently set.

Return Value

VTK_OK The function has completed successfully and the Vtk_CtxtOption structure with the current option information has been returned to the application.
error code The function has failed. For information about possible error values, refer to Appendix 

Notes

The application must release the returned Vtk_CtxtOption structure using the Vtk_CtxtOptionDeleteContent function.


See Also

Vtk_CtxtLogType

Vtk_CtxtSetOption

prevnext


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