Files
libgit2/group__git__reference.html
Carlos Martín Nieto 8c7ff8a765 generated docs
2011-04-07 13:27:55 +02:00

843 lines
44 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libgit2: Git reference management routines</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libgit2</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Git reference management routines</div> </div>
</div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#ga27d4d1f990ab44db4e43d96444784bb2">git_reference_lookup</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> **reference_out, <a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *repo, const char *name)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Lookup a reference by its name in a repository. <a href="#ga27d4d1f990ab44db4e43d96444784bb2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#ga764f6e1e6b0add709f7f7bda08d39ebb">git_reference_create_symbolic</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> **ref_out, <a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *repo, const char *name, const char *target)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new symbolic reference. <a href="#ga764f6e1e6b0add709f7f7bda08d39ebb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#gac1f2023d107ba84d6094d74f33663aaa">git_reference_create_symbolic_f</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> **ref_out, <a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *repo, const char *name, const char *target)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new symbolic reference, overwriting an existing one with the same name, if it exists. <a href="#gac1f2023d107ba84d6094d74f33663aaa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#ga7212b63f84615b986e7de48786dc62ff">git_reference_create_oid</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> **ref_out, <a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *repo, const char *name, const <a class="el" href="structgit__oid.html">git_oid</a> *id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new object id reference. <a href="#ga7212b63f84615b986e7de48786dc62ff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#gaa687480131274cd5dbcc090d49fec8ae">git_reference_create_oid_f</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> **ref_out, <a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *repo, const char *name, const <a class="el" href="structgit__oid.html">git_oid</a> *id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new object id reference, overwriting an existing one with the same name, if it exists. <a href="#gaa687480131274cd5dbcc090d49fec8ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structgit__oid.html">git_oid</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#ga3763c37730f979436969b8ff356a8dbd">git_reference_oid</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *ref)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the OID pointed to by a reference. <a href="#ga3763c37730f979436969b8ff356a8dbd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#ga971d79adaaccf88a7e12e27a3362046c">git_reference_target</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *ref)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get full name to the reference pointed by this reference. <a href="#ga971d79adaaccf88a7e12e27a3362046c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ae6d9729eb1feb0fdaa0ea953855c5173">git_rtype</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#ga037cb3a61eaa1f838f97ed3d7c53344c">git_reference_type</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *ref)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the type of a reference. <a href="#ga037cb3a61eaa1f838f97ed3d7c53344c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#ga8937ccecf089464ec02c220fa78369b6">git_reference_name</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *ref)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the full name of a reference. <a href="#ga8937ccecf089464ec02c220fa78369b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#ga2ba64210770489cde12c86ef8eebbfa3">git_reference_resolve</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> **resolved_ref, <a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *ref)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolve a symbolic reference. <a href="#ga2ba64210770489cde12c86ef8eebbfa3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#ga38806129039de18718f7d9370d4f6ee1">git_reference_owner</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *ref)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the repository where a reference resides. <a href="#ga38806129039de18718f7d9370d4f6ee1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#gabed056c0ff9a9b7a4db515ef6b737368">git_reference_set_target</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *ref, const char *target)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the symbolic target of a reference. <a href="#gabed056c0ff9a9b7a4db515ef6b737368"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#ga8e61e2db94b83b13e05f1c309f85828f">git_reference_set_oid</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *ref, const <a class="el" href="structgit__oid.html">git_oid</a> *id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the OID target of a reference. <a href="#ga8e61e2db94b83b13e05f1c309f85828f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#ga71167ed4411d06d74341376c00ca1d57">git_reference_rename</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *ref, const char *new_name)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Rename an existing reference. <a href="#ga71167ed4411d06d74341376c00ca1d57"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#ga11ff493df6a721af982839e983443296">git_reference_rename_f</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *ref, const char *new_name)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Rename an existing reference, overwriting an existing one with the same name, if it exists. <a href="#ga11ff493df6a721af982839e983443296"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#ga1fe9af4c798c086e58b8d6bd5b2f1b57">git_reference_delete</a> (<a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *ref)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete an existing reference. <a href="#ga1fe9af4c798c086e58b8d6bd5b2f1b57"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#ga7ad6b97ea4fdc608f62d72b376b2a150">git_reference_packall</a> (<a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *repo)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Pack all the loose references in the repository. <a href="#ga7ad6b97ea4fdc608f62d72b376b2a150"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#ga3ae9092b0a41e9fc76086cedcb4ef50f">git_reference_listall</a> (<a class="el" href="structgit__strarray.html">git_strarray</a> *array, <a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *repo, unsigned int list_flags)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Fill a list with all the references that can be found in a repository. <a href="#ga3ae9092b0a41e9fc76086cedcb4ef50f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__git__reference.html#gae75ecd3abc94d7c1db8f4e018dd10792">git_reference_listcb</a> (<a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *repo, unsigned int list_flags, int(*callback)(const char *, void *), void *payload)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">List all the references in the repository, calling a custom callback for each one. <a href="#gae75ecd3abc94d7c1db8f4e018dd10792"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga7212b63f84615b986e7de48786dc62ff"></a><!-- doxytag: member="refs.h::git_reference_create_oid" ref="ga7212b63f84615b986e7de48786dc62ff" args="(git_reference **ref_out, git_repository *repo, const char *name, const git_oid *id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int git_reference_create_oid </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> **&#160;</td>
<td class="paramname"><em>ref_out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *&#160;</td>
<td class="paramname"><em>repo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structgit__oid.html">git_oid</a> *&#160;</td>
<td class="paramname"><em>id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new object id reference. </p>
<p>The reference will be created in the repository and written to the disk.</p>
<p>This reference is owned by the repository and shall not be free'd by the user.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ref_out</td><td>Pointer to the newly created reference </td></tr>
<tr><td class="paramname">repo</td><td>Repository where that reference will live </td></tr>
<tr><td class="paramname">name</td><td>The name of the reference </td></tr>
<tr><td class="paramname">id</td><td>The object id pointed to by the reference. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="gaa687480131274cd5dbcc090d49fec8ae"></a><!-- doxytag: member="refs.h::git_reference_create_oid_f" ref="gaa687480131274cd5dbcc090d49fec8ae" args="(git_reference **ref_out, git_repository *repo, const char *name, const git_oid *id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int git_reference_create_oid_f </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> **&#160;</td>
<td class="paramname"><em>ref_out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *&#160;</td>
<td class="paramname"><em>repo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structgit__oid.html">git_oid</a> *&#160;</td>
<td class="paramname"><em>id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new object id reference, overwriting an existing one with the same name, if it exists. </p>
<p>If the new reference isn't an object id one, any pointers to the old reference become invalid.</p>
<p>The reference will be created in the repository and written to the disk.</p>
<p>This reference is owned by the repository and shall not be free'd by the user.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ref_out</td><td>Pointer to the newly created reference </td></tr>
<tr><td class="paramname">repo</td><td>Repository where that reference will live </td></tr>
<tr><td class="paramname">name</td><td>The name of the reference </td></tr>
<tr><td class="paramname">id</td><td>The object id pointed to by the reference. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga764f6e1e6b0add709f7f7bda08d39ebb"></a><!-- doxytag: member="refs.h::git_reference_create_symbolic" ref="ga764f6e1e6b0add709f7f7bda08d39ebb" args="(git_reference **ref_out, git_repository *repo, const char *name, const char *target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int git_reference_create_symbolic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> **&#160;</td>
<td class="paramname"><em>ref_out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *&#160;</td>
<td class="paramname"><em>repo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>target</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new symbolic reference. </p>
<p>The reference will be created in the repository and written to the disk.</p>
<p>This reference is owned by the repository and shall not be free'd by the user.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ref_out</td><td>Pointer to the newly created reference </td></tr>
<tr><td class="paramname">repo</td><td>Repository where that reference will live </td></tr>
<tr><td class="paramname">name</td><td>The name of the reference </td></tr>
<tr><td class="paramname">target</td><td>The target of the reference </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="gac1f2023d107ba84d6094d74f33663aaa"></a><!-- doxytag: member="refs.h::git_reference_create_symbolic_f" ref="gac1f2023d107ba84d6094d74f33663aaa" args="(git_reference **ref_out, git_repository *repo, const char *name, const char *target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int git_reference_create_symbolic_f </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> **&#160;</td>
<td class="paramname"><em>ref_out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *&#160;</td>
<td class="paramname"><em>repo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>target</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new symbolic reference, overwriting an existing one with the same name, if it exists. </p>
<p>If the new reference isn't a symbolic one, any pointers to the old reference become invalid.</p>
<p>The reference will be created in the repository and written to the disk.</p>
<p>This reference is owned by the repository and shall not be free'd by the user.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ref_out</td><td>Pointer to the newly created reference </td></tr>
<tr><td class="paramname">repo</td><td>Repository where that reference will live </td></tr>
<tr><td class="paramname">name</td><td>The name of the reference </td></tr>
<tr><td class="paramname">target</td><td>The target of the reference </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga1fe9af4c798c086e58b8d6bd5b2f1b57"></a><!-- doxytag: member="refs.h::git_reference_delete" ref="ga1fe9af4c798c086e58b8d6bd5b2f1b57" args="(git_reference *ref)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int git_reference_delete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *&#160;</td>
<td class="paramname"><em>ref</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete an existing reference. </p>
<p>This method works for both direct and symbolic references.</p>
<p>The reference will be immediately removed on disk and from memory. The given reference pointer will no longer be valid. </p>
</div>
</div>
<a class="anchor" id="ga3ae9092b0a41e9fc76086cedcb4ef50f"></a><!-- doxytag: member="refs.h::git_reference_listall" ref="ga3ae9092b0a41e9fc76086cedcb4ef50f" args="(git_strarray *array, git_repository *repo, unsigned int list_flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int git_reference_listall </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgit__strarray.html">git_strarray</a> *&#160;</td>
<td class="paramname"><em>array</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *&#160;</td>
<td class="paramname"><em>repo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>list_flags</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fill a list with all the references that can be found in a repository. </p>
<p>The listed references may be filtered by type, or using a bitwise OR of several types. Use the magic value `GIT_REF_LISTALL` to obtain all references, including packed ones.</p>
<p>The string array will be filled with the names of all references; these values are owned by the user and should be free'd manually when no longer needed, using `git_strarray_free`.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">array</td><td>Pointer to a <a class="el" href="structgit__strarray.html">git_strarray</a> structure where the reference names will be stored </td></tr>
<tr><td class="paramname">repo</td><td>Repository where to find the refs </td></tr>
<tr><td class="paramname">list_flags</td><td>Filtering flags for the reference listing. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="gae75ecd3abc94d7c1db8f4e018dd10792"></a><!-- doxytag: member="refs.h::git_reference_listcb" ref="gae75ecd3abc94d7c1db8f4e018dd10792" args="(git_repository *repo, unsigned int list_flags, int(*callback)(const char *, void *), void *payload)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int git_reference_listcb </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *&#160;</td>
<td class="paramname"><em>repo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>list_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(const char *, void *)&#160;</td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>payload</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>List all the references in the repository, calling a custom callback for each one. </p>
<p>The listed references may be filtered by type, or using a bitwise OR of several types. Use the magic value `GIT_REF_LISTALL` to obtain all references, including packed ones.</p>
<p>The `callback` function will be called for each of the references in the repository, and will receive the name of the reference and the `payload` value passed to this method.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">repo</td><td>Repository where to find the refs </td></tr>
<tr><td class="paramname">list_flags</td><td>Filtering flags for the reference listing. </td></tr>
<tr><td class="paramname">callback</td><td>Function which will be called for every listed ref </td></tr>
<tr><td class="paramname">payload</td><td>Additional data to pass to the callback </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga27d4d1f990ab44db4e43d96444784bb2"></a><!-- doxytag: member="refs.h::git_reference_lookup" ref="ga27d4d1f990ab44db4e43d96444784bb2" args="(git_reference **reference_out, git_repository *repo, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int git_reference_lookup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> **&#160;</td>
<td class="paramname"><em>reference_out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *&#160;</td>
<td class="paramname"><em>repo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Lookup a reference by its name in a repository. </p>
<p>The generated reference is owned by the repository and should not be freed by the user.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">reference_out</td><td>pointer to the looked-up reference </td></tr>
<tr><td class="paramname">repo</td><td>the repository to look up the reference </td></tr>
<tr><td class="paramname">name</td><td>the long name for the reference (e.g. HEAD, ref/heads/master, refs/tags/v0.1.0, ...) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga8937ccecf089464ec02c220fa78369b6"></a><!-- doxytag: member="refs.h::git_reference_name" ref="ga8937ccecf089464ec02c220fa78369b6" args="(git_reference *ref)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* git_reference_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *&#160;</td>
<td class="paramname"><em>ref</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the full name of a reference. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ref</td><td>The reference </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the full name for the ref </dd></dl>
</div>
</div>
<a class="anchor" id="ga3763c37730f979436969b8ff356a8dbd"></a><!-- doxytag: member="refs.h::git_reference_oid" ref="ga3763c37730f979436969b8ff356a8dbd" args="(git_reference *ref)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structgit__oid.html">git_oid</a>* git_reference_oid </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *&#160;</td>
<td class="paramname"><em>ref</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the OID pointed to by a reference. </p>
<p>Only available if the reference is direct (i.e. not symbolic)</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ref</td><td>The reference </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the oid if available, NULL otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga38806129039de18718f7d9370d4f6ee1"></a><!-- doxytag: member="refs.h::git_reference_owner" ref="ga38806129039de18718f7d9370d4f6ee1" args="(git_reference *ref)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a>* git_reference_owner </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *&#160;</td>
<td class="paramname"><em>ref</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the repository where a reference resides. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ref</td><td>The reference </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the repo </dd></dl>
</div>
</div>
<a class="anchor" id="ga7ad6b97ea4fdc608f62d72b376b2a150"></a><!-- doxytag: member="refs.h::git_reference_packall" ref="ga7ad6b97ea4fdc608f62d72b376b2a150" args="(git_repository *repo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int git_reference_packall </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a69f80526f06bad7d1aead7949c2840f5">git_repository</a> *&#160;</td>
<td class="paramname"><em>repo</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pack all the loose references in the repository. </p>
<p>This method will load into the cache all the loose references on the repository and update the `packed-refs` file with them.</p>
<p>Once the `packed-refs` file has been written properly, the loose references will be removed from disk.</p>
<p>WARNING: calling this method may invalidate any existing references previously loaded on the cache.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">repo</td><td>Repository where the loose refs will be packed </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga71167ed4411d06d74341376c00ca1d57"></a><!-- doxytag: member="refs.h::git_reference_rename" ref="ga71167ed4411d06d74341376c00ca1d57" args="(git_reference *ref, const char *new_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int git_reference_rename </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *&#160;</td>
<td class="paramname"><em>ref</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>new_name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Rename an existing reference. </p>
<p>This method works for both direct and symbolic references. The new name will be checked for validity and may be modified into a normalized form.</p>
<p>The refernece will be immediately renamed in-memory and on disk. </p>
</div>
</div>
<a class="anchor" id="ga11ff493df6a721af982839e983443296"></a><!-- doxytag: member="refs.h::git_reference_rename_f" ref="ga11ff493df6a721af982839e983443296" args="(git_reference *ref, const char *new_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int git_reference_rename_f </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *&#160;</td>
<td class="paramname"><em>ref</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>new_name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Rename an existing reference, overwriting an existing one with the same name, if it exists. </p>
<p>This method works for both direct and symbolic references. The new name will be checked for validity and may be modified into a normalized form.</p>
<p>The refernece will be immediately renamed in-memory and on disk. </p>
</div>
</div>
<a class="anchor" id="ga2ba64210770489cde12c86ef8eebbfa3"></a><!-- doxytag: member="refs.h::git_reference_resolve" ref="ga2ba64210770489cde12c86ef8eebbfa3" args="(git_reference **resolved_ref, git_reference *ref)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int git_reference_resolve </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> **&#160;</td>
<td class="paramname"><em>resolved_ref</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *&#160;</td>
<td class="paramname"><em>ref</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resolve a symbolic reference. </p>
<p>Thie method iteratively peels a symbolic reference until it resolves to a direct reference to an OID.</p>
<p>If a direct reference is passed as an argument, that reference is returned immediately</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">resolved_ref</td><td>Pointer to the peeled reference </td></tr>
<tr><td class="paramname">ref</td><td>The reference </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga8e61e2db94b83b13e05f1c309f85828f"></a><!-- doxytag: member="refs.h::git_reference_set_oid" ref="ga8e61e2db94b83b13e05f1c309f85828f" args="(git_reference *ref, const git_oid *id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int git_reference_set_oid </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *&#160;</td>
<td class="paramname"><em>ref</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structgit__oid.html">git_oid</a> *&#160;</td>
<td class="paramname"><em>id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the OID target of a reference. </p>
<p>The reference must be a direct reference, otherwise this method will fail.</p>
<p>The reference will be automatically updated in memory and on disk.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ref</td><td>The reference </td></tr>
<tr><td class="paramname">target</td><td>The new target OID for the reference </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="gabed056c0ff9a9b7a4db515ef6b737368"></a><!-- doxytag: member="refs.h::git_reference_set_target" ref="gabed056c0ff9a9b7a4db515ef6b737368" args="(git_reference *ref, const char *target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int git_reference_set_target </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *&#160;</td>
<td class="paramname"><em>ref</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>target</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the symbolic target of a reference. </p>
<p>The reference must be a symbolic reference, otherwise this method will fail.</p>
<p>The reference will be automatically updated in memory and on disk.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ref</td><td>The reference </td></tr>
<tr><td class="paramname">target</td><td>The new target for the reference </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; error code otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga971d79adaaccf88a7e12e27a3362046c"></a><!-- doxytag: member="refs.h::git_reference_target" ref="ga971d79adaaccf88a7e12e27a3362046c" args="(git_reference *ref)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* git_reference_target </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *&#160;</td>
<td class="paramname"><em>ref</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get full name to the reference pointed by this reference. </p>
<p>Only available if the reference is symbolic</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ref</td><td>The reference </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the name if available, NULL otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga037cb3a61eaa1f838f97ed3d7c53344c"></a><!-- doxytag: member="refs.h::git_reference_type" ref="ga037cb3a61eaa1f838f97ed3d7c53344c" args="(git_reference *ref)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ae6d9729eb1feb0fdaa0ea953855c5173">git_rtype</a> git_reference_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a356aa0f9b904c79a52cd4dfba4da14cd">git_reference</a> *&#160;</td>
<td class="paramname"><em>ref</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the type of a reference. </p>
<p>Either direct (GIT_REF_OID) or symbolic (GIT_REF_SYMBOLIC)</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ref</td><td>The reference </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the type </dd></dl>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Apr 7 2011 13:27:55 for libgit2 by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>