📄 ocilib_checks.h
字号:
/*
+----------------------------------------------------------------------+
| |
| OCILIB - C Driver for Oracle |
| |
| (C Wrapper for Oracle OCI) |
| |
+----------------------------------------------------------------------+
| Website : http://ocilib.net |
+----------------------------------------------------------------------+
| Copyright (c) 2007-2009 Vincent ROGIER |
+----------------------------------------------------------------------+
| This library is free software; you can redistribute it and/or |
| modify it under the terms of the GNU Library General Public |
| License as published by the Free Software Foundation; either |
| version 2 of the License, or (at your option) any later version. |
| |
| This library is distributed in the hope that it will be useful, |
| but WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| Library General Public License for more details. |
| |
| You should have received a copy of the GNU Library General Public |
| License along with this library; if not, write to the Free |
| Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
+----------------------------------------------------------------------+
| Author: Vincent ROGIER <vince.rogier@gmail.com> |
+----------------------------------------------------------------------+
*/
/* ------------------------------------------------------------------------ *
* $Id: ocilib_checks.h, v 3.2.0 2009/04/20 00:00 Vince $
* ------------------------------------------------------------------------ */
#ifndef OCILIB_OCILIB_CHECKS_H_INCLUDED
#define OCILIB_OCILIB_CHECKS_H_INCLUDED
/* ************************************************************************ *
MACROS FOR CHECKING OCI CALLS
* ************************************************************************ */
/**
* @brief
* Direct OCI call with return value checking
*
* @param res - OCI call result
* @param err - OCI error handle
* @param fct - OCI function
*
* @note
* Throws an exception on failure
*
*/
#define OCI_CALL0(res, err, fct) \
\
{ \
(res) = (boolean) fct; \
if (OCI_NO_ERROR((res)) == FALSE) \
{ \
OCI_ExceptionOCI((err), NULL, NULL); \
(res) = FALSE; \
} \
else \
(res) = TRUE; \
}
/**
* @brief
* Conditional OCI call with return value checking
*
* @param res - OCI call result
* @param con - OCILIB connection objet
* @param stmt - OCILIB statement object
* @param fct - OCI function
*
* @note
* Calls the OCI function only if the 'res' variable is TRUE
* Throws an exception on failure.
* Uses the OCI error handle of the connection object
*
*/
#define OCI_CALL1(res, con, stmt, fct) \
\
{ \
if ((res) == TRUE) \
{ \
(res) = (boolean) fct; \
if (OCI_NO_ERROR((res)) == FALSE) \
{ \
OCI_ExceptionOCI((con)->err, (con), (stmt)); \
(res) = FALSE; \
} \
else \
(res) = TRUE; \
} \
}
/**
* @brief
* Conditional OCI call with return value checking
*
* @param res - OCI call result
* @param con - OCILIB connection objet
* @param fct - OCI function
*
* @note
* Calls the OCI function only if the 'res' variable is TRUE
* Throws an exception on failure.
* Uses the OCI error handle of the connection object
*
*/
#define OCI_CALL2(res, con, fct) \
\
{ \
if ((res) == TRUE) \
{ \
(res) = (boolean) fct; \
if (OCI_NO_ERROR((res)) == FALSE) \
{ \
OCI_ExceptionOCI((con)->err, (con), NULL); \
(res) = FALSE; \
} \
else \
(res) = TRUE; \
} \
}
/**
* @brief
* Conditional OCI call with return value checking
*
* @param res - OCI call result
* @param err - OCI error handle
* @param fct - OCI function
*
* @note
* Throws an exception on failure
*
*/
#define OCI_CALL3(res, err, fct) \
\
{ \
if ((res) == TRUE) \
{ \
(res) = (boolean) fct; \
if (OCI_NO_ERROR((res)) == FALSE) \
{ \
OCI_ExceptionOCI((err), NULL, NULL); \
(res) = FALSE; \
} \
else \
(res) = TRUE; \
} \
}
/**
* @brief
* Conditional OCI call with return value checking
*
* @param res - OCI call result
* @param err - OCI error handle
* @param con - OCILIB connection objet
* @param fct - OCI function
*
* @note
* Calls the OCI function only if the 'res' variable is TRUE
* Throws an exception on failure.
*
*/
#define OCI_CALL4(res, err, con, fct) \
\
{ \
if ((res) == TRUE) \
{ \
(res) = (boolean) fct; \
if (OCI_NO_ERROR((res)) == FALSE) \
{ \
OCI_ExceptionOCI((err), (con), NULL); \
(res) = FALSE; \
} \
else \
(res) = TRUE; \
} \
}
/**
* @brief
* Direct OCI call with return value checking
* @param res - OCI call result
* @param con - OCILIB connection objet
* @param stmt - OCILIB statement object
* @param fct - OCI function
*
* @note
* Calls the OCI function only if the 'res' variable is TRUE
* Throws an exception on failure.
* Uses the OCI error handle of the connection object
*
*/
#define OCI_CALL5(res, con, stmt, fct) \
\
{ \
(res) = (boolean) fct; \
if (OCI_NO_ERROR((res)) == FALSE) \
{ \
OCI_ExceptionOCI((con)->err, (con), (stmt)); \
(res) = FALSE; \
} \
else \
(res) = TRUE; \
}
/* ************************************************************************ *
PARAMETER CHECKING MACROS
* ************************************************************************ */
/**
* @brief
* Internal general purpose expression checking
*
* @param exp - Expression
* @param ret - Return value if 'exp' is true
*
* @note
* Does not throw an exception.
*
*/
#define OCI_CHECK(exp, ret) if ((exp) == TRUE) return (ret);
/**
* @brief
* Checks if a pointer passed to public function is NULL
*
* @param type - Pointer type
* @param ptr - Pointer
* @param ret - Return value
*
* @note
* Throws an exception if the pointer is null.
*
*/
#define OCI_CHECK_PTR(type, ptr, ret) \
\
if ((ptr) == NULL) \
{ \
OCI_ExceptionNullPointer(type); \
\
return (ret); \
}
/**
* @brief
* Checks if the parameters of a bind call are valid
*
* @param stmt - Statement handle
* @param name - Bind name/literal position
* @param data - Input pointer to bind
* @param type - Input pointer type
*
* @note
* Throws an exception if one of the parameters is invalid and then returns
* FALSE.
*
*/
#define OCI_CHECK_BIND_CALL(stmt, name, data, type) \
\
OCI_CHECK_PTR(OCI_IPC_STATEMENT, stmt, FALSE); \
OCI_CHECK_PTR(OCI_IPC_STRING, name, FALSE); \
OCI_CHECK_PTR(type, data, FALSE); \
/**
* @brief
* Checks if the parameters of a register call are valid
*
* @param stmt - Statement handle
* @param name - Bind name/literal position
*
* @note
* Throws an exception if one of the parameters is invalid and returns FALSE.
*
*/
#define OCI_CHECK_REGISTER_CALL(stmt, name) \
\
OCI_CHECK_PTR(OCI_IPC_STATEMENT, stmt, FALSE); \
OCI_CHECK_PTR(OCI_IPC_STRING, name, FALSE); \
/* ************************************************************************ *
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -