<!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>libmcs: src/libmcs/mcs_util.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>src/libmcs/mcs_util.c File Reference</h1> </div>
</div>
<div class="contents">
<code>#include "<a class="el" href="mcs_8h_source.html">libmcs/mcs.h</a>"</code><br/>
<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">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="mcs__util_8c.html#a9954e2de04f2f48e369eae1f21bd7dc9">mcs_strnlen</a> (const char *str, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines the length of a string, limited by an arbitrary length. <a href="#a9954e2de04f2f48e369eae1f21bd7dc9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="mcs__util_8c.html#ab974df60bd8579e0b5096d0bc0a8ebf6">mcs_strndup</a> (const char *str, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Duplicates a string, limited to a specific length. <a href="#ab974df60bd8579e0b5096d0bc0a8ebf6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mcs__util_8c.html#a4302800a4deddc11d69137738f2e9e87">mcs_create_directory</a> (const char *path, mode_t mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A utility function which creates a directory. <a href="#a4302800a4deddc11d69137738f2e9e87"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="mcs__util_8c.html#a672253e33d633d9abba450aaeabd8577">mcs_strlcat</a> (char *dest, const char *src, size_t count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Concatenates a string, limited to a maximum buffer size. <a href="#a672253e33d633d9abba450aaeabd8577"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="mcs__util_8c.html#ae6fdae66e1cf42dd969eb09aa34a6869">mcs_strlcpy</a> (char *dest, const char *src, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copies a string, limited to a maximum buffer size. <a href="#ae6fdae66e1cf42dd969eb09aa34a6869"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a4302800a4deddc11d69137738f2e9e87"></a><!-- doxytag: member="mcs_util.c::mcs_create_directory" ref="a4302800a4deddc11d69137738f2e9e87" args="(const char *path, mode_t mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mcs_create_directory </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mode_t </td>
<td class="paramname"> <em>mode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A utility function which creates a directory. </p>
<p>This function creates a directory. It recurses to handle any parents which also need to be created.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>The path to create. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>The mode of the directory that should be created. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, -1 on failure. </dd></dl>
<p>References <a class="el" href="mcs_8h.html#ab974df60bd8579e0b5096d0bc0a8ebf6">mcs_strndup()</a>.</p>
</div>
</div>
<a class="anchor" id="a672253e33d633d9abba450aaeabd8577"></a><!-- doxytag: member="mcs_util.c::mcs_strlcat" ref="a672253e33d633d9abba450aaeabd8577" args="(char *dest, const char *src, size_t count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mcs_strlcat </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Concatenates a string, limited to a maximum buffer size. </p>
<p>This is a function which is useful for safely copying a string.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>The string to copy to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>The string to copy from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>The maximum allowed length of the string. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The length of the new string. </dd></dl>
</div>
</div>
<a class="anchor" id="ae6fdae66e1cf42dd969eb09aa34a6869"></a><!-- doxytag: member="mcs_util.c::mcs_strlcpy" ref="ae6fdae66e1cf42dd969eb09aa34a6869" args="(char *dest, const char *src, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mcs_strlcpy </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copies a string, limited to a maximum buffer size. </p>
<p>This is a function which is useful for safely copying a string.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>The string to copy to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>The string to copy from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>The maximum allowed length of the string. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The length of the new string. </dd></dl>
</div>
</div>
<a class="anchor" id="ab974df60bd8579e0b5096d0bc0a8ebf6"></a><!-- doxytag: member="mcs_util.c::mcs_strndup" ref="ab974df60bd8579e0b5096d0bc0a8ebf6" args="(const char *str, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mcs_strndup </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Duplicates a string, limited to a specific length. </p>
<p>This is a function which duplicates a string limited to a maximum length.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>The string to duplicate. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>The maximum allowed length of the string. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The pointer to a copy of the string. Free this with free(). </dd></dl>
<p>References <a class="el" href="mcs_8h.html#a9954e2de04f2f48e369eae1f21bd7dc9">mcs_strnlen()</a>.</p>
<p>Referenced by <a class="el" href="mcs__util_8c.html#a4302800a4deddc11d69137738f2e9e87">mcs_create_directory()</a>.</p>
</div>
</div>
<a class="anchor" id="a9954e2de04f2f48e369eae1f21bd7dc9"></a><!-- doxytag: member="mcs_util.c::mcs_strnlen" ref="a9954e2de04f2f48e369eae1f21bd7dc9" args="(const char *str, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mcs_strnlen </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determines the length of a string, limited by an arbitrary length. </p>
<p>This is a function which is useful for limiting the length of a string.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>The string to test. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>The maximum allowed length of the string. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The length of the string or len, whichever is smaller. </dd></dl>
<p>Referenced by <a class="el" href="mcs__util_8c.html#ab974df60bd8579e0b5096d0bc0a8ebf6">mcs_strndup()</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jan 20 2011 for libmcs by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
