[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
This commit is contained in:
Greg Clayton 2022-09-28 17:33:12 -07:00
parent 4d15e7b21b
commit b3a0bed5fb
1 changed files with 4 additions and 0 deletions

View File

@ -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();