OrbbecSDK
2.8.7
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
Toggle main menu visibility
Loading...
Searching...
No Matches
include
libobsensor
h
Error.h
Go to the documentation of this file.
1
// Copyright (c) Orbbec Inc. All Rights Reserved.
2
// Licensed under the MIT License.
3
8
#pragma once
9
10
#ifdef __cplusplus
11
extern
"C"
{
12
#endif
13
14
#include "
ObTypes.h
"
15
27
OB_EXPORT
ob_error
*
ob_create_error
(
ob_status
status,
const
char
*message,
const
char
*function,
const
char
*args,
ob_exception_type
exception_type);
28
35
OB_EXPORT
ob_status
ob_error_get_status
(
const
ob_error
*error);
36
43
OB_EXPORT
const
char
*
ob_error_get_message
(
const
ob_error
*error);
44
51
OB_EXPORT
const
char
*
ob_error_get_function
(
const
ob_error
*error);
52
59
OB_EXPORT
const
char
*
ob_error_get_args
(
const
ob_error
*error);
60
67
OB_EXPORT
ob_exception_type
ob_error_get_exception_type
(
const
ob_error
*error);
68
74
OB_EXPORT
void
ob_delete_error
(
ob_error
*error);
75
76
// The following interfaces are deprecated and are retained here for compatibility purposes.
77
#define ob_error_status ob_error_get_status
78
#define ob_error_message ob_error_get_message
79
#define ob_error_function ob_error_get_function
80
#define ob_error_args ob_error_get_args
81
#define ob_error_exception_type ob_error_get_exception_type
82
83
#ifdef __cplusplus
84
}
85
#endif
ob_error_get_exception_type
OB_EXPORT ob_exception_type ob_error_get_exception_type(const ob_error *error)
Get the type of exception that caused the error.
ob_delete_error
OB_EXPORT void ob_delete_error(ob_error *error)
Delete the error object.
ob_error_get_message
OB_EXPORT const char * ob_error_get_message(const ob_error *error)
Get the error message.
ob_create_error
OB_EXPORT ob_error * ob_create_error(ob_status status, const char *message, const char *function, const char *args, ob_exception_type exception_type)
Create a new error object.
ob_error_get_status
OB_EXPORT ob_status ob_error_get_status(const ob_error *error)
Get the error status.
ob_error_get_args
OB_EXPORT const char * ob_error_get_args(const ob_error *error)
Get the error parameters.
ob_error_get_function
OB_EXPORT const char * ob_error_get_function(const ob_error *error)
Get the name of the API function that caused the error.
ObTypes.h
Provide structs commonly used in the SDK, enumerating constant definitions.
ob_exception_type
enum OBExceptionType ob_exception_type
ob_status
enum OBStatus ob_status
ob_error
The error class exposed by the SDK, users can get detailed error information according to the error.
Definition
ObTypes.h:159
Generated on
for OrbbecSDK by
1.17.0