Vtk_StatusToStrings
Toolkit Reference

prevnext

Vtk_StatusToStrings

#include <vtk_errs.h>
const char **Vtk_StatusToString(
Vtk_uint32 status /* input/output */
);

Description

This translation routine returns a null-terminated array of strings containing text associated with every value contained in the status value. The end of the array is indicated by a NULL entry.

Parameters

status Status value to be translated. The status value is defined as a bit field which can represent multiple status codes.

Return Value

char ** The function has completed successfully and the status values have been translated into the requisite number of strings, one for each status code. The corresponding symbol for this value is VTK_OK.
NULL The function has failed.

Notes

The application must call the Vtk_StatusStringsDelete function for each array created.



See Also

Vtk_ErrorToString

Vtk_StatusStringsDelete

prevnext


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