include/git2/strarray.h

0001 /*
0002  * Copyright (C) the libgit2 contributors. All rights reserved.
0003  *
0004  * This file is part of libgit2, distributed under the GNU GPL v2 with
0005  * a Linking Exception. For full terms see the included COPYING file.
0006  */
0007 #ifndef INCLUDE_git_strarray_h__
0008 #define INCLUDE_git_strarray_h__
0009
0010 #include "common.h"
0011
0012 /**
0013  * @file git2/strarray.h
0014  * @brief Git string array routines
0015  * @defgroup git_strarray Git string array routines
0016  * @ingroup Git
0017  * @{
0018  */
0019 GIT_BEGIN_DECL
0020
0021 /** Array of strings */
0022 typedef struct git_strarray {
0023     char **strings;
0024     size_t count;
0025 } git_strarray;
0026
0027 /**
0028  * Free the strings contained in a string array.  This method should
0029  * be called on `git_strarray` objects that were provided by the
0030  * library.  Not doing so, will result in a memory leak.
0031  *
0032  * This does not free the `git_strarray` itself, since the library will
0033  * never allocate that object directly itself.
0034  *
0035  * @param array The git_strarray that contains strings to free
0036  */
0037 GIT_EXTERN(void) git_strarray_dispose(git_strarray *array);
0038
0039 /** @} */
0040 GIT_END_DECL
0041
0042 #endif
0043