ScCommon.h File Reference
Go to the source code of this file.
Data Structures | |
struct ScPoint | |
struct ScQuadrilateral | |
struct ScPointF | |
struct ScSize | |
struct ScSizeF | |
struct ScRectangleF | |
struct ScQuadrilateralF | |
struct ScError | |
struct ScImageBuffer | |
Enumerations | |
enum ScCameraFocusMode { SC_CAMERA_FOCUS_MODE_UNKNOWN = 0, SC_CAMERA_FOCUS_MODE_FIXED = 1, SC_CAMERA_FOCUS_MODE_AUTO, SC_CAMERA_FOCUS_MODE_MANUAL = 4 } | |
enum ScErrorType { SC_NO_ERROR = 0, SC_ERROR_UNKNOWN = 1, SC_ERROR_NOT_IMPLEMENTED = 2, SC_ERROR_INVALID_INPUT = 3, SC_ERROR_INTERNAL_ERROR = 4 } | |
enum ScInformationKey { SC_INFORMATION_KEY_SOFTWARE_LICENSES = 0, SC_INFORMATION_KEY_SDK_VERSION = 1, SC_INFORMATION_KEY_SDK_BUILD = 2 } | |
Functions | |
void sc_free (void *pointer) | |
void sc_error_free (ScError *error) | |
char const * sc_get_information_string (ScInformationKey key) | |
Detailed Description
Common functions and data structures.
- Copyright
- Copyright (c) 2015 Scandit AG. All rights reserved.
Data Structure Documentation
struct ScSize |
struct ScSizeF |
struct ScError |
Enumeration Type Documentation
enum ScCameraFocusMode |
Describes the focus mode of a camera.
- Since
- 4.6.0
enum ScErrorType |
Enumeration of different error types.
- Since
- 5.8
enum ScInformationKey |
Enumeration of different information strings.
Values of this enumeration are passed to sc_get_information_string to retrieve specific information.
- Since
- 4.16.1
Function Documentation
void sc_free | ( | void * | pointer | ) |
Deallocates the memory allocation pointed to by pointer
.
- Parameters
-
pointer The pointer to be deallocated. In case pointer
is a null pointer, no operation is performed.
void sc_error_free | ( | ScError * | error | ) |
free's any memory associated with the error
Upon exit, the data fields are set to 0.
- Parameters
-
error the error to free.
- Since
- 4.11.0
char const* sc_get_information_string | ( | ScInformationKey | key | ) |
Get information string.
- Parameters
-
key information identifier
- Returns
- The string associated with the given key, null if no string is associated with the key. The returned key is constant and must not be freed by the caller.
- Since
- 4.16.1