LLVM  14.0.0git
Macros | Typedefs | Functions | Variables
Error.h File Reference
#include "llvm-c/ExternC.h"
Include dependency graph for Error.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define LLVMErrorSuccess   0
 

Typedefs

typedef struct LLVMOpaqueError * LLVMErrorRef
 Opaque reference to an error instance. More...
 

Functions

LLVMErrorTypeId LLVMGetErrorTypeId (LLVMErrorRef Err)
 Returns the type id for the given error instance, which must be a failure value (i.e. More...
 
void LLVMConsumeError (LLVMErrorRef Err)
 Dispose of the given error without handling it. More...
 
char * LLVMGetErrorMessage (LLVMErrorRef Err)
 Returns the given string's error message. More...
 
void LLVMDisposeErrorMessage (char *ErrMsg)
 Dispose of the given error message. More...
 
LLVMErrorTypeId LLVMGetStringErrorTypeId (void)
 Returns the type id for llvm StringError. More...
 
LLVMErrorRef LLVMCreateStringError (const char *ErrMsg)
 Create a StringError. More...
 

Variables

const typedef void * LLVMErrorTypeId
 Error type identifier. More...
 

Macro Definition Documentation

◆ LLVMErrorSuccess

#define LLVMErrorSuccess   0

Definition at line 21 of file Error.h.

Typedef Documentation

◆ LLVMErrorRef

typedef struct LLVMOpaqueError* LLVMErrorRef

Opaque reference to an error instance.

Null serves as the 'success' value.

Definition at line 26 of file Error.h.

Function Documentation

◆ LLVMConsumeError()

void LLVMConsumeError ( LLVMErrorRef  Err)

Dispose of the given error without handling it.

This operation consumes the error, and the given LLVMErrorRef value is not usable once this call returns. Note: This method only needs to be called if the error is not being passed to some other consuming operation, e.g. LLVMGetErrorMessage.

Definition at line 156 of file Error.cpp.

◆ LLVMCreateStringError()

LLVMErrorRef LLVMCreateStringError ( const char *  ErrMsg)

Create a StringError.

Definition at line 172 of file Error.cpp.

◆ LLVMDisposeErrorMessage()

void LLVMDisposeErrorMessage ( char *  ErrMsg)

Dispose of the given error message.

Definition at line 166 of file Error.cpp.

◆ LLVMGetErrorMessage()

char* LLVMGetErrorMessage ( LLVMErrorRef  Err)

Returns the given string's error message.

This operation consumes the error, and the given LLVMErrorRef value is not usable once this call returns. The caller is responsible for disposing of the string by calling LLVMDisposeErrorMessage.

Definition at line 158 of file Error.cpp.

◆ LLVMGetErrorTypeId()

LLVMErrorTypeId LLVMGetErrorTypeId ( LLVMErrorRef  Err)

Returns the type id for the given error instance, which must be a failure value (i.e.

non-null).

Definition at line 152 of file Error.cpp.

◆ LLVMGetStringErrorTypeId()

LLVMErrorTypeId LLVMGetStringErrorTypeId ( void  )

Returns the type id for llvm StringError.

Definition at line 168 of file Error.cpp.

Variable Documentation

◆ LLVMErrorTypeId

const typedef void* LLVMErrorTypeId

Error type identifier.

Definition at line 31 of file Error.h.