Scippy

SCIP

Solving Constraint Integer Programs

retcode.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and library */
4 /* SCIP --- Solving Constraint Integer Programs */
5 /* */
6 /* Copyright (c) 2002-2024 Zuse Institute Berlin (ZIB) */
7 /* */
8 /* Licensed under the Apache License, Version 2.0 (the "License"); */
9 /* you may not use this file except in compliance with the License. */
10 /* You may obtain a copy of the License at */
11 /* */
12 /* http://www.apache.org/licenses/LICENSE-2.0 */
13 /* */
14 /* Unless required by applicable law or agreed to in writing, software */
15 /* distributed under the License is distributed on an "AS IS" BASIS, */
16 /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17 /* See the License for the specific language governing permissions and */
18 /* limitations under the License. */
19 /* */
20 /* You should have received a copy of the Apache-2.0 license */
21 /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22 /* */
23 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24 
25 /**@file retcode.h
26  * @ingroup INTERNALAPI
27  * @brief internal methods for return codes for SCIP methods
28  * @author Tobias Achterberg
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_RETCODE_H__
34 #define __SCIP_RETCODE_H__
35 
36 #include <stdio.h>
37 
38 #include "scip/pub_message.h"
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /** prints error message for return code */
45 void SCIPretcodePrint(
46  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
47  FILE* file, /**< file stream to write error message */
48  SCIP_RETCODE retcode /**< SCIP return code causing the error */
49  );
50 
51 /** prints error message for return code via error message */
53  SCIP_RETCODE retcode /**< SCIP return code causing the error */
54  );
55 
56 #ifdef __cplusplus
57 }
58 #endif
59 
60 #endif
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
void SCIPretcodePrint(SCIP_MESSAGEHDLR *messagehdlr, FILE *file, SCIP_RETCODE retcode)
Definition: retcode.c:38
void SCIPretcodePrintError(SCIP_RETCODE retcode)
Definition: retcode.c:113
public methods for message output