UPD: WFX plugin API description

This commit is contained in:
Alexander Koblov 2010-05-23 08:10:37 +00:00
commit d6ae80b2a0
3 changed files with 43 additions and 15 deletions

View file

@ -3,7 +3,8 @@
<head>
<meta name="GENERATOR" content="PasDoc 0.11.0">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Writing file system plugins for Double Commander</title>
<title>Writing file system
plugins for Double Commander</title>
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255);"
@ -69,12 +70,16 @@ int Action, int MaxLen);</code></td>
<td class="itemcode"><code>BOOL
__stdcall</code><code>&nbsp;<a href="#FsNetworkOpenConnection">FsNetworkOpenConnection</a>(</code><code>char*
</code><code>Connection,&nbsp;</code><code>char*</code><code>
RootDir,</code><code>
</code><code>char*</code><code>
RemotePath, int
MaxLen);<br>
</code><code>BOOL
__stdcall</code><code>&nbsp;<a
href="wfxplugin.html#FsNetworkOpenConnectionW">FsNetworkOpenConnectionW</a>(</code><code></code><code>WCHAR</code><code>*
</code><code>Connection,&nbsp;</code><code></code><code>WCHAR</code><code>*</code><code>
</code><code>RootDir</code><code>,
WCHAR</code><code>*</code><code>
RemotePath, int
MaxLen);</code></td>
</tr>
@ -138,8 +143,7 @@ characters (including the final 0) which fit in the buffer.</dd>
<tr class="list">
<td class="itemcode"><code><a name="FsNetworkGetConnection"></a></code><code>BOOL
__stdcall&nbsp;FsNetworkGetConnection(</code><code>int
Index, char*
</code><code>Connection,
Index, char* </code><code>Connection,
int MaxLen);<br>
</code><code><a name="FsNetworkGetConnectionW"></a>BOOL
__stdcall&nbsp;FsNetworkGetConnectionW(</code><code>int
@ -234,11 +238,15 @@ otherwise</p>
<td class="itemcode"><code><a name="FsNetworkOpenConnection"></a></code><code>BOOL
__stdcall</code><code>&nbsp;FsNetworkOpenConnection(</code><code>char*
</code><code>Connection,&nbsp;</code><code>char*</code><code>
RootDir,</code><code>
</code><code>char*</code><code>
RemotePath, int
MaxLen);<br>
</code><code><a name="FsNetworkOpenConnectionW"></a>BOOL
__stdcall</code><code>&nbsp;FsNetworkOpenConnectionW(</code><code></code><code>WCHAR</code><code>*
</code><code>Connection,&nbsp;</code><code></code><code>WCHAR</code><code>*</code><code>
</code><code>Connection,&nbsp;</code><code>WCHAR</code><code>*</code><code>
RootDir,</code><code>
</code><code></code><code>WCHAR</code><code>*</code><code>
RemotePath, int
MaxLen);</code><code></code></td>
</tr>
@ -255,15 +263,18 @@ network</span></span>.</p>
<dd>Out: Server
address, e.g. "ftp://ftp.chg.ru"<br>
</dd>
<dt>RootDir</dt>
<dd>Here the plugin has to
return the root directory of the opening connection, e.g. "/"</dd>
<dt>RemotePath</dt>
<dd>Here the plugin has to
return the remote path of the opening connection, e.g. "/pub/Linux"</dd>
<dt>MaxLen</dt>
<dd>Maximum number of
characters that you can return in Connection and RemotePath, including
characters that you can return in Connection, RootDir and RemotePath,
including
the
final 0.
</dd>
final 0. </dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">The

View file

@ -335,4 +335,21 @@ int __stdcall FsContentSetValue(char* FileName,int FieldIndex,int UnitIndex,int
int __stdcall FsContentSetValueW(WCHAR* FileName,int FieldIndex,int UnitIndex,int FieldType,void* FieldValue,int flags);
BOOL __stdcall FsContentGetDefaultView(char* ViewContents,char* ViewHeaders,char* ViewWidths,char* ViewOptions,int maxlen);
BOOL __stdcall FsContentGetDefaultViewW(WCHAR* ViewContents,WCHAR* ViewHeaders,WCHAR* ViewWidths,WCHAR* ViewOptions,int maxlen);
BOOL __stdcall FsContentGetDefaultViewW(WCHAR* ViewContents,WCHAR* ViewHeaders,WCHAR* ViewWidths,WCHAR* ViewOptions,int maxlen);
// ******* Network API extension *******
#define FS_NM_ACTION_ADD 0
#define FS_NM_ACTION_EDIT 1
#define FS_NM_ACTION_DELETE 2
void __stdcall FsNetworkGetSupportedProtocols(char* Protocols, int MaxLen);
void __stdcall FsNetworkGetSupportedProtocolsW(WCHAR* Protocols, int MaxLen);
BOOL __stdcall FsNetworkGetConnection(int Index, char* Connection, int MaxLen);
BOOL __stdcall FsNetworkGetConnectionW(int Index, WCHAR* Connection, int MaxLen);
BOOL __stdcall FsNetworkManageConnection(HWND MainWin, char* Connection, int Action, int MaxLen);
BOOL __stdcall FsNetworkManageConnectionW(HWND MainWin, WCHAR* Connection, int Action, int MaxLen);
BOOL __stdcall FsNetworkOpenConnection(char* Connection, char* RootDir, char* RemotePath, int MaxLen);
BOOL __stdcall FsNetworkOpenConnectionW(WCHAR* Connection, WCHAR* RootDir, WCHAR* RemotePath, int MaxLen);

View file

@ -337,9 +337,9 @@ function FsMkDir(RemoteDir:pchar):bool; stdcall;
function FsMkDirW(RemoteDir:pwidechar):bool; stdcall;
function FsExecuteFile(MainWin:thandle;RemoteName,Verb:pchar):integer; stdcall;
function FsExecuteFile(MainWin:HWND;RemoteName,Verb:pchar):integer; stdcall;
function FsExecuteFileW(MainWin:thandle;RemoteName,Verb:pwidechar):integer; stdcall;
function FsExecuteFileW(MainWin:HWND;RemoteName,Verb:pwidechar):integer; stdcall;
function FsRenMovFile(OldName,NewName:pchar;Move,OverWrite:bool;
@ -543,7 +543,7 @@ function FsContentGetDefaultViewW(ViewContents,ViewHeaders,ViewWidths,
}
{ Network API }
{ Network API extension }
const
FS_NM_ACTION_ADD = 0;
@ -564,13 +564,13 @@ function FsNetworkGetConnection(Index: LongInt; Connection: PAnsiChar; MaxLen: L
function FsNetworkGetConnectionW(Index: LongInt; Connection: PWideChar; MaxLen: LongInt): LongBool; stdcall;
function FsNetworkManageConnection(Connection: PAnsiChar; Action: LongInt; MaxLen: LongInt): LongBool; stdcall;
function FsNetworkManageConnection(MainWin: HWND; Connection: PAnsiChar; Action: LongInt; MaxLen: LongInt): LongBool; stdcall;
function FsNetworkManageConnectionW(Connection: PWideChar; Action: LongInt; MaxLen: LongInt): LongBool; stdcall;
function FsNetworkManageConnectionW(MainWin: HWND; Connection: PWideChar; Action: LongInt; MaxLen: LongInt): LongBool; stdcall;
function FsNetworkOpenConnection(Connection: PAnsiChar; RemotePath: PAnsiChar; MaxLen: LongInt): LongBool; stdcall;
function FsNetworkOpenConnection(Connection: PAnsiChar; RootDir, RemotePath: PAnsiChar; MaxLen: LongInt): LongBool; stdcall;
function FsNetworkOpenConnectionW(Connection: PWideChar; RemotePath: PWideChar; MaxLen: LongInt): LongBool; stdcall;
function FsNetworkOpenConnectionW(Connection: PWideChar; RootDir, RemotePath: PWideChar; MaxLen: LongInt): LongBool; stdcall;
}