Status types and values

Macros
#define	PEAK_SUCCESS(status)
	Check for the status code to indicate success. More...
#define	PEAK_WARNING(status)
	Check for the status code to indicate a warning. More...
#define	PEAK_ERROR(status)
	Check for the status code to indicate an error. More...
#define	PEAK_IS_WRITEABLE(accessStatus)
	Check for the access status code to indicate write access to be possible. More...
#define	PEAK_IS_READABLE(accessStatus)
	Check for the access status code to indicate read access to be possible. More...

Enumerations
enum	peak_status {   PEAK_STATUS_SUCCESS, PEAK_STATUS_WARNING, PEAK_STATUS_VALUE_ADJUSTED, PEAK_STATUS_ERROR,   PEAK_STATUS_NOT_INITIALIZED, PEAK_STATUS_NOT_IMPLEMENTED, PEAK_STATUS_ACCESS_DENIED, PEAK_STATUS_CAMERA_NOT_FOUND,   PEAK_STATUS_CAMERA_NOT_AVAILABLE, PEAK_STATUS_INVALID_HANDLE, PEAK_STATUS_INVALID_PARAMETER, PEAK_STATUS_OUT_OF_RANGE,   PEAK_STATUS_BUFFER_TOO_SMALL, PEAK_STATUS_INVALID_CONFIGURATION, PEAK_STATUS_TIMEOUT, PEAK_STATUS_ABORTED,   PEAK_STATUS_NO_DATA, PEAK_STATUS_INVALID_PEAK_INSTALLATION, PEAK_STATUS_BUSY }
	peak Status codes More...
enum	peak_access_status {   PEAK_ACCESS_INVALID, PEAK_ACCESS_NOT_SUPPORTED, PEAK_ACCESS_NONE, PEAK_ACCESS_GFA_LOCK,   PEAK_ACCESS_READONLY, PEAK_ACCESS_WRITEONLY, PEAK_ACCESS_READWRITE }
	peak Access status codes More...

Detailed Description

Definitions on status types and values.

Macro Definition Documentation

PEAK_ERROR

#define PEAK_ERROR

(

status

)

Check for the status code to indicate an error.

Evaluates the specified peak_status code to indicate an error.

Parameters

[in]

status

The status code to evaluate.

Returns

PEAK_TRUE status indicates an error.

PEAK_FALSE status does not indicate an error.

PEAK_IS_READABLE

#define PEAK_IS_READABLE

(

accessStatus

)

Check for the access status code to indicate read access to be possible.

Evaluates the specified peak_access_status code to indicate read access to be possible.

Parameters

[in]

accessStatus

The access status code to evaluate.

Returns

PEAK_TRUE accessStatus indicates read access to be possible.

PEAK_FALSE accessStatus does not indicate read access to be possible. Consider that the access status may indicate a failed access status query.

See also

Access Status Query, especially Simplified Evaluation of an Access Status

PEAK_IS_WRITEABLE

#define PEAK_IS_WRITEABLE

(

accessStatus

)

Check for the access status code to indicate write access to be possible.

Evaluates the specified peak_access_status code to indicate write access to be possible.

Parameters

[in]

accessStatus

The access status code to evaluate.

Returns

PEAK_TRUE accessStatus indicates write access to be possible.

PEAK_FALSE accessStatus does not indicate write access to be possible. Consider that the access status may indicate a failed access status query.

See also

Access Status Query, especially Simplified Evaluation of an Access Status

PEAK_SUCCESS

#define PEAK_SUCCESS

(

status

)

Check for the status code to indicate success.

Evaluates the specified peak_status code to indicate success.

Parameters

[in]

status

The status code to evaluate.

Returns

PEAK_TRUE status indicates success.

PEAK_FALSE status does not indicate success.

PEAK_WARNING

#define PEAK_WARNING

(

status

)

Check for the status code to indicate a warning.

Evaluates the specified peak_status code to indicate a warning.

Parameters

[in]

status

The status code to evaluate.

Returns

PEAK_TRUE status indicates a warning.

PEAK_FALSE status does not indicate a warning.

Enumeration Type Documentation

peak_access_status

enum peak_access_status

peak Access status codes

The access status can be queried for several features and for a camera.

See also

Access Status

Enumerator
PEAK_ACCESS_INVALID	Invalid access status code. Use this value for the initialization of variables of type peak_access_status. Note This access status code is also used by the library to indicate a failed access status query. See Access Status Query on this.
PEAK_ACCESS_NOT_SUPPORTED	Not supported. The feature is not supported. Not all cameras support all features.
PEAK_ACCESS_NONE	No access. The feature or the camera is currently not accessible at all.
PEAK_ACCESS_GFA_LOCK	No access. The feature or the camera is currently not accessible due to the status of the GFA write access. The Convenience Interface functions are not accessible if the GFA write lock is enabled.
PEAK_ACCESS_READONLY	Read only access. The feature is currently available for read only access.
PEAK_ACCESS_WRITEONLY	Write only access. The feature is currently available for write only access.
PEAK_ACCESS_READWRITE	Read write access. The feature or the camera is currently available for read and for write access.

peak_status

enum peak_status

peak Status codes

The majority of the peak functions return a status code.

Enumerator
PEAK_STATUS_SUCCESS	Success.
PEAK_STATUS_WARNING	Unspecified warning.
PEAK_STATUS_VALUE_ADJUSTED	The set value was auto-adjusted. This status code indicates that a value which was set to a feature was automatically adjusted by the implementation or the camera.
PEAK_STATUS_ERROR	Unspecified error. This status code is typically returned on an unexpected error in the library implementation and should not show up.
PEAK_STATUS_NOT_INITIALIZED	The library is not initialized. Call peak_Library_Init.
PEAK_STATUS_NOT_IMPLEMENTED	The function is not implemented.
PEAK_STATUS_ACCESS_DENIED	The access to the requested feature was denied due to the current system status.
PEAK_STATUS_CAMERA_NOT_FOUND	There is no such camera.
PEAK_STATUS_CAMERA_NOT_AVAILABLE	The specified camera is not available.
PEAK_STATUS_INVALID_HANDLE	The handle is invalid.
PEAK_STATUS_INVALID_PARAMETER	One or more parameters are invalid.
PEAK_STATUS_OUT_OF_RANGE	The value or configuration is out of the valid range.
PEAK_STATUS_BUFFER_TOO_SMALL	The buffer is too small to take the complete data.
PEAK_STATUS_INVALID_CONFIGURATION	The current configuration of an addressed module does not allow the requested operation to be executed.
PEAK_STATUS_TIMEOUT	A timeout occurred.
PEAK_STATUS_ABORTED	The operation was aborted.
PEAK_STATUS_NO_DATA	The specified or requested data is not present.
PEAK_STATUS_INVALID_PEAK_INSTALLATION	The peak installation is corrupted.
PEAK_STATUS_BUSY	Device or resource is busy.