1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META http-equiv="Content-Style-Type" content="text/css">
7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
8<title>VFGetApiErrorString</title>
9</head>
10
11<body>
12
13<h1>VFGetApiErrorString</h1>
14
15<h2>C Specification</h2>
16<dl><dd><pre><code>
17#include &lt;revolution/vf.h&gt;
18
19const char* VFGetApiErrorString( VFErr error );
20</code></pre></dd></dl>
21
22<h2>Arguments</h2>
23<p>
24<TABLE border="1" >
25  <tr>
26<TD valign="top" width="120" bgcolor="#ffffe8"><CODE><STRONG><EM>error</EM></STRONG></CODE></TD>
27<TD width="520">VF error value.</TD>
28  </tr>
29</TABLE>
30</p>
31
32<h2>Return Values</h2>
33<PRE>
34The error string.
35For example, if <CODE>VF_ERR_EIO</CODE> is passed by the argument, the function returns the string: <CODE>VF_ERR_EIO</CODE> (I/O Error(Driver Error))
36</PRE>
37
38
39<H2>Description</H2>
40<p>
41For debugging purposes, gets the error string from the VF error value (<CODE>VFErr</CODE>).<br>
42</p>
43
44<h2>See Also</h2>
45<p>
46<code><a href="./VFErr.html">VFErr</a></code>
47</p>
48
49<H2>Revision History</H2>
50<p>2007/05/08 Initial version.</p>
51
52
53<hr><p>CONFIDENTIAL</p></body>
54</html>
55