diff options
Diffstat (limited to 'include/git2/strarray.h')
-rw-r--r-- | include/git2/strarray.h | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/include/git2/strarray.h b/include/git2/strarray.h new file mode 100644 index 0000000..03d93f8 --- /dev/null +++ b/include/git2/strarray.h @@ -0,0 +1,43 @@ +/* + * Copyright (C) the libgit2 contributors. All rights reserved. + * + * This file is part of libgit2, distributed under the GNU GPL v2 with + * a Linking Exception. For full terms see the included COPYING file. + */ +#ifndef INCLUDE_git_strarray_h__ +#define INCLUDE_git_strarray_h__ + +#include "common.h" + +/** + * @file git2/strarray.h + * @brief Git string array routines + * @defgroup git_strarray Git string array routines + * @ingroup Git + * @{ + */ +GIT_BEGIN_DECL + +/** Array of strings */ +typedef struct git_strarray { + char **strings; + size_t count; +} git_strarray; + +/** + * Free the strings contained in a string array. This method should + * be called on `git_strarray` objects that were provided by the + * library. Not doing so, will result in a memory leak. + * + * This does not free the `git_strarray` itself, since the library will + * never allocate that object directly itself. + * + * @param array The git_strarray that contains strings to free + */ +GIT_EXTERN(void) git_strarray_dispose(git_strarray *array); + +/** @} */ +GIT_END_DECL + +#endif + |