Add a comment to clarify the contract for LLVMGetErrorMessage in the c-bindings

for Error.

llvm-svn: 343394
This commit is contained in:
Lang Hames 2018-09-29 23:49:54 +00:00
parent 6ca6a03c51
commit d18d69f25a
1 changed files with 2 additions and 0 deletions

View File

@ -47,6 +47,8 @@ void LLVMConsumeError(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.
*/
char *LLVMGetErrorMessage(LLVMErrorRef Err);