Error Handling

The functions in this section provide access to additional information related to error returns. More...

Functions
SPINNAKERC_API	spinErrorGetLast (spinError *pError)
	Retrieves the error code of the last error. More...
SPINNAKERC_API	spinErrorGetLastMessage (char *pBuf, size_t *pBufLen)
	Retrieves the error message of the last error. More...
SPINNAKERC_API	spinErrorGetLastBuildDate (char *pBuf, size_t *pBufLen)
	Retrieves the build date of the last error. More...
SPINNAKERC_API	spinErrorGetLastBuildTime (char *pBuf, size_t *pBufLen)
	Retrieves the build time of the last error. More...
SPINNAKERC_API	spinErrorGetLastFileName (char *pBuf, size_t *pBufLen)
	Retrieves the filename of the last error. More...
SPINNAKERC_API	spinErrorGetLastFullMessage (char *pBuf, size_t *pBufLen)
	Retrieves the full error message of the last error. More...
SPINNAKERC_API	spinErrorGetLastFunctionName (char *pBuf, size_t *pBufLen)
	Retrieves the function name of the last error. More...
SPINNAKERC_API	spinErrorGetLastLineNumber (int64_t *pLineNum)
	Retrieves the line number of the last error. More...

Detailed Description

The functions in this section provide access to additional information related to error returns.

Function Documentation

spinErrorGetLast()

SPINNAKERC_API spinErrorGetLast

(

spinError *

pError

)

Retrieves the error code of the last error.

See also

spinError

Parameters

pError

The error enum pointer in which the error message is returned

Returns

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

spinErrorGetLastBuildDate()

SPINNAKERC_API spinErrorGetLastBuildDate	(	char *	pBuf,
		size_t *	pBufLen
	)

Retrieves the build date of the last error.

See also

spinError

Parameters

pBuf	The c-string character buffer in which the build date is returned
pBufLen	The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

spinErrorGetLastBuildTime()

SPINNAKERC_API spinErrorGetLastBuildTime	(	char *	pBuf,
		size_t *	pBufLen
	)

Retrieves the build time of the last error.

See also

spinError

Parameters

pBuf	The c-string character buffer in which the build time is returned
pBufLen	The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

spinErrorGetLastFileName()

SPINNAKERC_API spinErrorGetLastFileName	(	char *	pBuf,
		size_t *	pBufLen
	)

Retrieves the filename of the last error.

See also

spinError

Parameters

pBuf	The c-string character buffer in which the file name is returned
pBufLen	The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

spinErrorGetLastFullMessage()

SPINNAKERC_API spinErrorGetLastFullMessage	(	char *	pBuf,
		size_t *	pBufLen
	)

Retrieves the full error message of the last error.

See also

spinError

Parameters

pBuf	The c-string character buffer in which the full error message is returned
pBufLen	The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

spinErrorGetLastFunctionName()

SPINNAKERC_API spinErrorGetLastFunctionName	(	char *	pBuf,
		size_t *	pBufLen
	)

Retrieves the function name of the last error.

See also

spinError

Parameters

pBuf	The c-string character buffer in which the function name is returned
pBufLen	The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

spinErrorGetLastLineNumber()

SPINNAKERC_API spinErrorGetLastLineNumber

(

int64_t *

pLineNum

)

Retrieves the line number of the last error.

See also

spinError

Parameters

pBuf	The c-string character buffer in which the line number is returned
pBufLen	The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

spinErrorGetLastMessage()

SPINNAKERC_API spinErrorGetLastMessage	(	char *	pBuf,
		size_t *	pBufLen
	)

Retrieves the error message of the last error.

See also

spinError

Parameters

pBuf	The c-string character buffer in which the error message is returned
pBufLen	The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Examples

Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Enumeration_C.c, EnumerationEvents_C.c, Exposure_C.c, ImageEvents_C.c, ImageFormatControl_C.c, LookupTable_C.c, NodeMapCallback_C.c, NodeMapInfo_C.c, SaveToVideo_C.c, Sequencer_C.c, and Trigger_C.c.