<!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>libsmbios_c library: /builddir/build/BUILD/libsmbios-2.2.26/src/include/smbios_c/token.h 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>Data Structures</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>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>/builddir/build/BUILD/libsmbios-2.2.26/src/include/smbios_c/token.h File Reference</h1> </div>
</div>
<div class="contents">
<code>#include "<a class="el" href="compat_8h_source.html">smbios_c/compat.h</a>"</code><br/>
<code>#include "<a class="el" href="types_8h_source.html">smbios_c/types.h</a>"</code><br/>
<p><a href="token_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#afbe16d41efd36f904df5eafdce0c3913">TOKEN_TYPE_D4</a> 0xD4</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#ab6890e7cf2a9043b36e2c7f8a4be0be8">TOKEN_TYPE_D5</a> 0xD5</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#a1a449efd8cfc024990bb153ef6481729">TOKEN_TYPE_D6</a> 0xD6</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#afed1f6b3ab93f525641dbe9fe6341036">TOKEN_TYPE_DA</a> 0xDA</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LIBSMBIOS_C_DLL_SPEC const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#a5d77707adfaf770884ffa3ca673a4df8">token_strerror</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string describing the last error condition. <a href="#a5d77707adfaf770884ffa3ca673a4df8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LIBSMBIOS_C_DLL_SPEC int </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#ae5b70414985d683c3010e239a0f77193">token_get_type</a> (<a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return token type. <a href="#ae5b70414985d683c3010e239a0f77193"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LIBSMBIOS_C_DLL_SPEC bool </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#a62fcc58c495f4c3e6683d067a91cb9ff">token_is_bool</a> (<a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a token is a boolean-type token. <a href="#a62fcc58c495f4c3e6683d067a91cb9ff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LIBSMBIOS_C_DLL_SPEC int </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#ab5da52bf342e4f69398a98bf28a0c418">token_is_active</a> (<a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a boolean token is currently set. <a href="#ab5da52bf342e4f69398a98bf28a0c418"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LIBSMBIOS_C_DLL_SPEC int </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#af9a8060f3eee854fcc93af287f839bc0">token_activate</a> (<a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Activate a boolean token. <a href="#af9a8060f3eee854fcc93af287f839bc0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LIBSMBIOS_C_DLL_SPEC bool </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#a7895ee8e418d0e70761630022ffcbc79">token_is_string</a> (<a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a token is a string-type token. <a href="#a7895ee8e418d0e70761630022ffcbc79"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LIBSMBIOS_C_DLL_SPEC char * </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#adb887e55d0caf2dc0426478e006246a6">token_get_string</a> (<a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> id, size_t *len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a new buffer containing the token string value. <a href="#adb887e55d0caf2dc0426478e006246a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LIBSMBIOS_C_DLL_SPEC int </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#a2d51a8d98d6ada1d3f951c7d3f2479b6">token_set_string</a> (<a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> id, const char *value, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string token value. <a href="#a2d51a8d98d6ada1d3f951c7d3f2479b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LIBSMBIOS_C_DLL_SPEC void </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#a6317cc863e90cc27a69bd845fac202c4">token_string_free</a> (char *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free allocated memory. <a href="#a6317cc863e90cc27a69bd845fac202c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LIBSMBIOS_C_DLL_SPEC struct <br class="typebreak"/>
smbios_struct * </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#a07cb995b8d8cee1f840b2ca4fd145113">token_get_smbios_struct</a> (<a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the smbios struct containing this token. <a href="#a07cb995b8d8cee1f840b2ca4fd145113"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LIBSMBIOS_C_DLL_SPEC const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#a1822e28b895c8181669b42de2199d03e">token_get_ptr</a> (<a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the actual token structure. <a href="#a1822e28b895c8181669b42de2199d03e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LIBSMBIOS_C_DLL_SPEC int </td><td class="memItemRight" valign="bottom"><a class="el" href="token_8h.html#aa1fe73668f62d29a8a9cbd64496e52b1">token_try_password</a> (<a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> id, const char *pass_ascii, const char *pass_scancode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For tokens that are password protected, check password. <a href="#aa1fe73668f62d29a8a9cbd64496e52b1"></a><br/></td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="afbe16d41efd36f904df5eafdce0c3913"></a><!-- doxytag: member="token.h::TOKEN_TYPE_D4" ref="afbe16d41efd36f904df5eafdce0c3913" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TOKEN_TYPE_D4 0xD4</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ab6890e7cf2a9043b36e2c7f8a4be0be8"></a><!-- doxytag: member="token.h::TOKEN_TYPE_D5" ref="ab6890e7cf2a9043b36e2c7f8a4be0be8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TOKEN_TYPE_D5 0xD5</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1a449efd8cfc024990bb153ef6481729"></a><!-- doxytag: member="token.h::TOKEN_TYPE_D6" ref="a1a449efd8cfc024990bb153ef6481729" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TOKEN_TYPE_D6 0xD6</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="afed1f6b3ab93f525641dbe9fe6341036"></a><!-- doxytag: member="token.h::TOKEN_TYPE_DA" ref="afed1f6b3ab93f525641dbe9fe6341036" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TOKEN_TYPE_DA 0xDA</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="af9a8060f3eee854fcc93af287f839bc0"></a><!-- doxytag: member="token.h::token_activate" ref="af9a8060f3eee854fcc93af287f839bc0" args="(u16 id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBSMBIOS_C_DLL_SPEC int token_activate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> </td>
<td class="paramname"> <em>id</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Activate a boolean token. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, <0 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a1822e28b895c8181669b42de2199d03e"></a><!-- doxytag: member="token.h::token_get_ptr" ref="a1822e28b895c8181669b42de2199d03e" args="(u16 id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBSMBIOS_C_DLL_SPEC const void* token_get_ptr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> </td>
<td class="paramname"> <em>id</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a pointer to the actual token structure. </p>
</div>
</div>
<a class="anchor" id="a07cb995b8d8cee1f840b2ca4fd145113"></a><!-- doxytag: member="token.h::token_get_smbios_struct" ref="a07cb995b8d8cee1f840b2ca4fd145113" args="(u16 id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBSMBIOS_C_DLL_SPEC struct smbios_struct* token_get_smbios_struct </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> </td>
<td class="paramname"> <em>id</em></td>
<td> ) </td>
<td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a pointer to the smbios struct containing this token. </p>
</div>
</div>
<a class="anchor" id="adb887e55d0caf2dc0426478e006246a6"></a><!-- doxytag: member="token.h::token_get_string" ref="adb887e55d0caf2dc0426478e006246a6" args="(u16 id, size_t *len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBSMBIOS_C_DLL_SPEC char* token_get_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> </td>
<td class="paramname"> <em>id</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>Get a new buffer containing the token string value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>token id to get </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>pointer to size_t where final string size will be stored. Size does not include final '\0', but may not always be equal to strlen() if cmos has embedded '\0' chars. You must use token_free_string() to free this buffer, or memory will leak. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to allocated buffer (note: use token_free_string() to free this value). 0 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ae5b70414985d683c3010e239a0f77193"></a><!-- doxytag: member="token.h::token_get_type" ref="ae5b70414985d683c3010e239a0f77193" args="(u16 id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBSMBIOS_C_DLL_SPEC int token_get_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> </td>
<td class="paramname"> <em>id</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return token type. </p>
<p>tokens can be 0xD4, 0xD5, 0xD6, or 0xDA tokens, depending on the smbios table structure they come from. </p>
</div>
</div>
<a class="anchor" id="ab5da52bf342e4f69398a98bf28a0c418"></a><!-- doxytag: member="token.h::token_is_active" ref="ab5da52bf342e4f69398a98bf28a0c418" args="(u16 id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBSMBIOS_C_DLL_SPEC int token_is_active </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> </td>
<td class="paramname"> <em>id</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if a boolean token is currently set. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>-1 on error, 0 == false, 1 == true </dd></dl>
</div>
</div>
<a class="anchor" id="a62fcc58c495f4c3e6683d067a91cb9ff"></a><!-- doxytag: member="token.h::token_is_bool" ref="a62fcc58c495f4c3e6683d067a91cb9ff" args="(u16 id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBSMBIOS_C_DLL_SPEC bool token_is_bool </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> </td>
<td class="paramname"> <em>id</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if a token is a boolean-type token. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if token is bool, false if otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="a7895ee8e418d0e70761630022ffcbc79"></a><!-- doxytag: member="token.h::token_is_string" ref="a7895ee8e418d0e70761630022ffcbc79" args="(u16 id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBSMBIOS_C_DLL_SPEC bool token_is_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> </td>
<td class="paramname"> <em>id</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if a token is a string-type token. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if token is a string, false otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a2d51a8d98d6ada1d3f951c7d3f2479b6"></a><!-- doxytag: member="token.h::token_set_string" ref="a2d51a8d98d6ada1d3f951c7d3f2479b6" args="(u16 id, const char *value, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBSMBIOS_C_DLL_SPEC int token_set_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>value</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>Set a string token value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>token id </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>pointer to new token buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>size of the buffer </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, <0 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a5d77707adfaf770884ffa3ca673a4df8"></a><!-- doxytag: member="token.h::token_strerror" ref="a5d77707adfaf770884ffa3ca673a4df8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBSMBIOS_C_DLL_SPEC const char* token_strerror </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns string describing the last error condition. </p>
<p>Can return 0. The buffer used is guaranteed to be valid until the next call to any token_* function. Copy the contents if you need it longer. </p>
</div>
</div>
<a class="anchor" id="a6317cc863e90cc27a69bd845fac202c4"></a><!-- doxytag: member="token.h::token_string_free" ref="a6317cc863e90cc27a69bd845fac202c4" args="(char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBSMBIOS_C_DLL_SPEC void token_string_free </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free allocated memory. </p>
<p>Use this to free any memory buffer pointers that you get from this module. For example, token_get_string(...) </p>
</div>
</div>
<a class="anchor" id="aa1fe73668f62d29a8a9cbd64496e52b1"></a><!-- doxytag: member="token.h::token_try_password" ref="aa1fe73668f62d29a8a9cbd64496e52b1" args="(u16 id, const char *pass_ascii, const char *pass_scancode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBSMBIOS_C_DLL_SPEC int token_try_password </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a9e6c91d77e24643b888dbd1a1a590054">u16</a> </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pass_ascii</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pass_scancode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>For tokens that are password protected, check password. </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Oct 5 2010 for libsmbios_c library 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>
