include/git2/oidarray.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_oidarray_h__
0008 #define INCLUDE_git_oidarray_h__
0009
0010 #include "common.h"
0011 #include "oid.h"
0012
0013 GIT_BEGIN_DECL
0014
0015 /** Array of object ids */
0016 typedef struct git_oidarray {
0017     git_oid *ids;
0018     size_t count;
0019 } git_oidarray;
0020
0021 /**
0022  * Free the object IDs contained in an oid_array.  This method should
0023  * be called on `git_oidarray` objects that were provided by the
0024  * library.  Not doing so will result in a memory leak.
0025  *
0026  * This does not free the `git_oidarray` itself, since the library will
0027  * never allocate that object directly itself.
0028  *
0029  * @param array git_oidarray from which to free oid data
0030  */
0031 GIT_EXTERN(void) git_oidarray_dispose(git_oidarray *array);
0032
0033 /** @} */
0034 GIT_END_DECL
0035
0036 #endif
0037