Library typedefs and consts for returned results

Typedefs
typedef int	wcStateVal
	Boolean operation completion codes. More...
typedef int	wcRCode
	Operation completion codes. More...

Variables
const wcRCode	WC_TRUE = 1
const wcRCode	WC_FALSE = 0
const wcRCode	WC_OK = 0
const wcRCode	WC_BAD_TARGET = -1
const wcRCode	WC_BAD_PARAM = -2
const wcRCode	WC_BAD_VALUE = -3
const wcRCode	WC_CLIENT_NOT_STREAMING = -4
const wcRCode	WC_NOT_A_TASK = -5
const wcRCode	WC_TASK_MISMATCH = -6
const wcRCode	WC_NOT_ENOUGH_MEM = -7

Detailed Description

Typedef Documentation

wcStateVal

typedef int wcStateVal

Boolean operation completion codes.

See also

WC_TRUE, WC_FALSE

wcRCode

typedef int wcRCode

Operation completion codes.

See also

wcStateVal, WC_OK, WC_BAD_TARGET, WC_BAD_PARAM, WC_BAD_VALUE, WC_CLIENT_NOT_STREAMING, WC_NOT_A_TASK, WC_TASK_MISMATCH, WC_NOT_ENOUGH_MEM

Variable Documentation

WC_TRUE

const wcRCode WC_TRUE = 1

The result is 'true' for this operation.

WC_FALSE

const wcRCode WC_FALSE = 0

The result is 'false' for this operation.

Examples

lib_test/main.cpp, media_test/main.cpp, multithread_test/main.cpp, theora_test/input_strm/main.cpp, and theora_test/output_strm/main.cpp.

WC_OK

const wcRCode WC_OK = 0

No error.

Examples

lib_test/main.cpp, media_test/main.cpp, multithread_test/main.cpp, theora_test/input_strm/main.cpp, and theora_test/output_strm/main.cpp.

WC_BAD_TARGET

const wcRCode WC_BAD_TARGET = -1

Invalid handle is specified.

WC_BAD_PARAM

const wcRCode WC_BAD_PARAM = -2

The enumeration value is invalid.

WC_BAD_VALUE

const wcRCode WC_BAD_VALUE = -3

The parameter value is invalid.

WC_CLIENT_NOT_STREAMING

const wcRCode WC_CLIENT_NOT_STREAMING = -4

This client is not streaming.

WC_NOT_A_TASK

const wcRCode WC_NOT_A_TASK = -5

An invalid pointer to the task was passed.

WC_TASK_MISMATCH

const wcRCode WC_TASK_MISMATCH = -6

This operation is not allowed for the selected task.

WC_NOT_ENOUGH_MEM

const wcRCode WC_NOT_ENOUGH_MEM = -7

There is not enough memory to complete the operation successfully.