List of Janus FTP Server $functions: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| (16 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
<div class="showVisit"> | <div class="showVisit"> | ||
The following are the available <var class="product">[[Janus FTP Server]]</var> $functions. These $functions constitute an API for writing [[Overriding FTP protocol commands|overrides]] of <var class="product">[[Janus FTP Server]]</var> implementations of basic FTP commands. | |||
The following are the available [[Janus FTP Server]] $functions. | |||
<table class="wikitable"> | <table class="wikitable"> | ||
<tr><th>$Function</th><th>Description</th></tr> | <tr class="head"><th>$Function</th><th>Description</th></tr> | ||
<!-- ************************************************************** --> | <!-- ************************************************************** --> | ||
<!-- Note that FUNSCHECK.WIKI depends on the format of the function name/description rows - *** SO DON'T MUCK WITH IT!!! *** --> | <!-- Note that FUNSCHECK.WIKI depends on the format of the function name/description rows - *** SO DON'T MUCK WITH IT!!! *** --> | ||
<!-- ************************************************************** --> | <!-- ************************************************************** --> | ||
<tr><td>[[$Ftp_Fail]]</td><td> </td> | <tr><td>[[Overriding FTP protocol commands#$Ftp_Fail|$Ftp_Fail]]</td><td>Makes available a failure status code (500) for the override. </td></tr> | ||
<tr><td>[[$Ftp_Get_Command]]</td><td> </td> | <tr><td>[[Overriding FTP protocol commands#$Ftp_Get_Command|$Ftp_Get_Command]]</td><td>Returns the FTP command that is the subject of the override.</td></tr> | ||
<tr><td>[[$Ftp_Get_Current_File]]</td><td> </td> | <tr><td>[[Overriding FTP protocol commands#$Ftp_Get_Current_File|$Ftp_Get_Current_File]]</td><td>Returns the <var class="product">Model 204</var> file mapped to the current folder.</td></tr> | ||
<tr><td>[[$Ftp_Get_Current_Folder]]</td><td> </td> | <tr><td>[[Overriding FTP protocol commands#$Ftp_Get_Current_Folder|$Ftp_Get_Current_Folder]]</td><td>Returns the name of the current folder.</td></tr> | ||
<tr><td>[[$Ftp_Get_Operand]]</td><td> </td> | <tr><td>[[Overriding FTP protocol commands#$Ftp_Get_Operand|$Ftp_Get_Operand]]</td><td>Returns the value of the entity being operated on by the FTP command that is being overridden.</td></tr> | ||
<tr><td>[[$Ftp_Get_Old_Name]]</td><td> </td> | <tr><td>[[Overriding FTP protocol commands#$Ftp_Get_Old_Name|$Ftp_Get_Old_Name]]</td><td>Returns the name of the procedure being renamed.</td></tr> | ||
<tr><td>[[$Ftp_Get_Prefix]]</td><td> </td> | <tr><td>[[Overriding FTP protocol commands#$Ftp_Get_Prefix|$Ftp_Get_Prefix]]</td><td>Returns the prefix character of a folder that is using prefixing.</td></tr> | ||
<tr><td>[[$Ftp_Get_Transfer_Type]]</td><td> </td> | <tr><td>[[Overriding FTP protocol commands#$Ftp_Get_Transfer_Type|$Ftp_Get_Transfer_Type]]</td><td>Returns the current client-specified FTP transfer mode.</td></tr> | ||
</table> | </table></div> | ||
</div> | |||
[[Category:$Functions| "$Ftp_xxx" functions]] | |||
[[Category:$Functions|$Ftp_xxx functions]] | |||
Latest revision as of 15:43, 3 June 2014
The following are the available Janus FTP Server $functions. These $functions constitute an API for writing overrides of Janus FTP Server implementations of basic FTP commands.
| $Function | Description |
|---|---|
| $Ftp_Fail | Makes available a failure status code (500) for the override. |
| $Ftp_Get_Command | Returns the FTP command that is the subject of the override. |
| $Ftp_Get_Current_File | Returns the Model 204 file mapped to the current folder. |
| $Ftp_Get_Current_Folder | Returns the name of the current folder. |
| $Ftp_Get_Operand | Returns the value of the entity being operated on by the FTP command that is being overridden. |
| $Ftp_Get_Old_Name | Returns the name of the procedure being renamed. |
| $Ftp_Get_Prefix | Returns the prefix character of a folder that is using prefixing. |
| $Ftp_Get_Transfer_Type | Returns the current client-specified FTP transfer mode. |