<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link rel="previous" href="Netcgi_types.simple_message.html"> <link rel="next" href="Netcgi_types.cgi_activation.html"> <link rel="Up" href="Netcgi_types.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of class methods" rel=Appendix href="index_methods.html"> <link title="Index of classes" rel=Appendix href="index_classes.html"> <link title="Index of class types" rel=Appendix href="index_class_types.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Netcgi_env" rel="Chapter" href="Netcgi_env.html"> <link title="Netcgi_types" rel="Chapter" href="Netcgi_types.html"> <link title="Netcgi" rel="Chapter" href="Netcgi.html"> <link title="Netcgi_jserv" rel="Chapter" href="Netcgi_jserv.html"> <link title="Netcgi_jserv_ajp12" rel="Chapter" href="Netcgi_jserv_ajp12.html"> <link title="Netcgi_jserv_app" rel="Chapter" href="Netcgi_jserv_app.html"> <link title="Netcgi_fcgi_10" rel="Chapter" href="Netcgi_fcgi_10.html"> <link title="Netcgi_fcgi" rel="Chapter" href="Netcgi_fcgi.html"> <link title="Netcgi1_compat" rel="Chapter" href="Netcgi1_compat.html"><title>Ocamlnet 2 Reference Manual (netcgi1 add-on) : Netcgi_types.cgi_argument</title> </head> <body> <div class="navbar"><a href="Netcgi_types.simple_message.html">Previous</a> <a href="Netcgi_types.html">Up</a> <a href="Netcgi_types.cgi_activation.html">Next</a> </div> <center><h1>Class type <a href="type_Netcgi_types.cgi_argument.html">Netcgi_types.cgi_argument</a></h1></center> <br> <pre><span class="keyword">class type</span> <a name="TYPEcgi_argument"></a>cgi_argument = <code class="code">object</code> <a href="Netcgi_types.cgi_argument.html">..</a> <code class="code">end</code></pre>The interface of CGI argument objects<br> <hr width="100%"> <pre><span class="keyword">method</span> <a name="METHODname"></a>name : <code class="type">string</code></pre><div class="info"> The name of the CGI argument<br> </div> <pre><span class="keyword">method</span> <a name="METHODvalue"></a>value : <code class="type">string</code></pre><div class="info"> The value of the CGI argument, after all transfer encodings have been removed. If the value is stored in a file, the file will be loaded.<br> </div> <pre><span class="keyword">method</span> <a name="METHODopen_value_rd"></a>open_value_rd : <code class="type">unit -> Netchannels.in_obj_channel</code></pre><div class="info"> Opens the contents of the value as an input channel. This works for all kinds of arguments, independent of <code class="code">store</code> and <code class="code">representation</code>.<br> </div> <pre><span class="keyword">method</span> <a name="METHODro"></a>ro : <code class="type">bool</code></pre><div class="info"> Whether this argument is read-only or not<br> </div> <pre><span class="keyword">method</span> <a name="METHODstore"></a>store : <code class="type"><a href="Netcgi_types.html#TYPEstore">store</a></code></pre><div class="info"> Returns where the argument value is stored<br> </div> <pre><span class="keyword">method</span> <a name="METHODcontent_type"></a>content_type : <code class="type">string</code></pre><div class="info"> Returns the content type of the header, or <code class="code">"text/plain"</code> when the header is missing. Parameters of the content type have been stripped off (e.g. <code class="code">charset</code>).<br> </div> <pre><span class="keyword">method</span> <a name="METHODcontent_type_params"></a>content_type_params : <code class="type">(string * Mimestring.s_param) list</code></pre><div class="info"> The parameters of the content type of the header, or <code class="code">[]</code> when the header is missing. Below you find access method for frequently used parameters.<br> </div> <pre><span class="keyword">method</span> <a name="METHODcharset"></a>charset : <code class="type">string</code></pre><div class="info"> The <code class="code">charset</code> parameter of the content type of the header, or <code class="code">""</code> when there is no such parameter, or no header.<br> </div> <pre><span class="keyword">method</span> <a name="METHODfilename"></a>filename : <code class="type">string option</code></pre><div class="info"> The <code class="code">filename</code> parameter found in the header of file uploads. When present, <code class="code">Some name</code> is returned, and <code class="code">None</code> otherwise.<br> </div> <pre><span class="keyword">method</span> <a name="METHODrepresentation"></a>representation : <code class="type"><a href="Netcgi_types.html#TYPErepresentation">representation</a></code></pre><div class="info"> The representation of the CGI argument<br> </div> <pre><span class="keyword">method</span> <a name="METHODfinalize"></a>finalize : <code class="type">unit -> unit</code></pre><div class="info"> Arguments stored in temp files must be deleted when the argument is no longer used. You can call <code class="code">finalize</code> to delete such files. The method does not have any effect when <code class="code">store = `Memory</code>. The method does never raise any exceptions. If the file does no longer exist (e.g. because it is moved away), or if there are any problems deleting the file, the error will be suppressed. The <code class="code">finalize</code> method is not registered in the garbage collector. You can do that, but it is usually better to call this method manually. <code class="code">cgi_activation</code> supports this.<br> </div> <pre><span class="keyword">method</span> <a name="METHODset_value"></a>set_value : <code class="type">string -> unit</code></pre><div class="info"> If the <code class="code">representation</code> supports mutable values, the value is set to the passed string. The other properties of the argument are not modified. <p> If the <code class="code">representation</code> does not support this feature, the exception <code class="code">Netmime.Immutable</code> will be raised.<br> </div> <pre><span class="keyword">method</span> <a name="METHODopen_value_wr"></a>open_value_wr : <code class="type">unit -> Netchannels.out_obj_channel</code></pre><div class="info"> Opens the value for writing. The current value is overwritten. If the value is immutable, the exception <code class="code">Netmime.Immutable</code> will be raised.<br> </div> </body></html>
