1 /*===-- clang-c/CXString.h - C Index strings --------------------*- C -*-===*\
3 |* The LLVM Compiler Infrastructure *|
5 |* This file is distributed under the University of Illinois Open Source *|
6 |* License. See LICENSE.TXT for details. *|
8 |*===----------------------------------------------------------------------===*|
10 |* This header provides the interface to C Index strings. *|
12 \*===----------------------------------------------------------------------===*/
14 #ifndef CLANG_CXSTRING_H
15 #define CLANG_CXSTRING_H
17 #include "clang-c/Platform.h"
24 * \defgroup CINDEX_STRING String manipulation routines
31 * \brief A character string.
33 * The \c CXString type is used to return strings from the interface when
34 * the ownership of that string might different from one call to the next.
35 * Use \c clang_getCString() to retrieve the string data and, once finished
36 * with the string data, call \c clang_disposeString() to free the string.
40 unsigned private_flags;
44 * \brief Retrieve the character data associated with the given string.
46 CINDEX_LINKAGE const char *clang_getCString(CXString string);
49 * \brief Free the given string,
51 CINDEX_LINKAGE void clang_disposeString(CXString string);