From b3a0bed5fb8766dcf27583ab1f73edc6e7232657 Mon Sep 17 00:00:00 2001 From: Greg Clayton Date: Wed, 28 Sep 2022 17:33:12 -0700 Subject: [PATCH] [NFC] Add header documentation to the SBError::GetCString() to clarify ownwership of the returned string. Title says it all! Differential Revision: https://reviews.llvm.org/D134846 --- lldb/include/lldb/API/SBError.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lldb/include/lldb/API/SBError.h b/lldb/include/lldb/API/SBError.h index b34014aecc44..30214e37c8e5 100644 --- a/lldb/include/lldb/API/SBError.h +++ b/lldb/include/lldb/API/SBError.h @@ -27,6 +27,10 @@ public: const SBError &operator=(const lldb::SBError &rhs); + /// Get the error string as a NULL terminated UTF8 c-string. + /// + /// This SBError object owns the returned string and this object must be kept + /// around long enough to use the returned string. const char *GetCString() const; void Clear();