<html>
<head>
<base href="https://wiki.asterisk.org/wiki">
<link rel="stylesheet" href="/wiki/s/en/2176/25/9/_/styles/combined.css?spaceKey=AST&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://wiki.asterisk.org/wiki/display/AST/Function_FAXOPT_res_fax">Function_FAXOPT_res_fax</a></h2>
<h4>Page <b>added</b> by <a href="https://wiki.asterisk.org/wiki/display/~wikibot">Wiki Bot</a>
</h4>
<br/>
<div class="notificationGreySide">
<h1><a name="Function_FAXOPT_res_fax-FAXOPT%28%29%5Cresfax%5C"></a>FAXOPT() - [res_fax]</h1>
<h3><a name="Function_FAXOPT_res_fax-Synopsis"></a>Synopsis</h3>
<p>Gets/sets various pieces of information about a fax session.</p>
<h3><a name="Function_FAXOPT_res_fax-Description"></a>Description</h3>
<p>FAXOPT can be used to override the settings for a FAX session listed in <tt>res_fax.conf</tt>, it can also be used to retreive information about a FAX session that has finished eg. pages/status.</p>
<h3><a name="Function_FAXOPT_res_fax-Syntax"></a>Syntax</h3>
<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>FAXOPT(item)</pre>
</div></div>
<h5><a name="Function_FAXOPT_res_fax-Arguments"></a>Arguments</h5>
<ul>
<li><tt>item</tt>
<ul>
<li><tt>ecm</tt> - R/W Error Correction Mode (ECM) enable with 'yes', disable with 'no'.</li>
<li><tt>error</tt> - R/O FAX transmission error code upon failure.</li>
<li><tt>filename</tt> - R/O Filename of the first file of the FAX transmission.</li>
<li><tt>filenames</tt> - R/O Filenames of all of the files in the FAX transmission (comma separated).</li>
<li><tt>headerinfo</tt> - R/W FAX header information.</li>
<li><tt>localstationid</tt> - R/W Local Station Identification.</li>
<li><tt>minrate</tt> - R/W Minimum transfer rate set before transmission.</li>
<li><tt>maxrate</tt> - R/W Maximum transfer rate set before transmission.</li>
<li><tt>modem</tt> - R/W Modem type (v17/v27/v29).</li>
<li><tt>pages</tt> - R/O Number of pages transferred.</li>
<li><tt>rate</tt> - R/O Negotiated transmission rate.</li>
<li><tt>remotestationid</tt> - R/O Remote Station Identification after transmission.</li>
<li><tt>resolution</tt> - R/O Negotiated image resolution after transmission.</li>
<li><tt>sessionid</tt> - R/O Session ID of the FAX transmission.</li>
<li><tt>status</tt> - R/O Result Status of the FAX transmission.</li>
<li><tt>statusstr</tt> - R/O Verbose Result Status of the FAX transmission.</li>
</ul>
</li>
</ul>
<h3><a name="Function_FAXOPT_res_fax-SeeAlso"></a>See Also</h3>
<ul>
<li><a href="/wiki/display/AST/Application_ReceiveFax" title="Application_ReceiveFax">Application_ReceiveFax</a></li>
<li><a href="/wiki/display/AST/Application_SendFax" title="Application_SendFax">Application_SendFax</a></li>
</ul>
<h3><a name="Function_FAXOPT_res_fax-ImportVersion"></a>Import Version</h3>
<p>This documentation was imported from Asterisk Version SVN-branch-1.8-r379342</p>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://wiki.asterisk.org/wiki/users/removespacenotification.action?spaceKey=AST">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://wiki.asterisk.org/wiki/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://wiki.asterisk.org/wiki/display/AST/Function_FAXOPT_res_fax">View Online</a>
|
<a href="https://wiki.asterisk.org/wiki/display/AST/Function_FAXOPT_res_fax?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>