vpGetError man page

vpGetError, vpGetErrorString — retrieve error codes

Synopsis

#include <volpack.h>

vpResult

vpGetError(vpc)

vpContext *vpc;

char *

vpGetErrorString(code)

vpResult code;

Arguments

vpc
VolPack context from vpCreateContext.
code
A VolPack error result code.

Description

These routines are used for error handling. vpGetError return the error code from the first function call that failed since the last call to vpGetError. vpGetErrorString returns a descriptive string corresponding to an error code. The string is stored in a global array so it does not need to be copied to separate memory.

Errors

vpGetError cannot fail. A return value not equal to VP_OK means that some previous function call has failed. vpGetErrorString returns NULL if code is invalid.

See Also

VolPack(3), vpCreateContext(3)

Referenced By

VolPack(3).

VolPack