NetDrive2 SDK Reference

Transcription

1 NetDrive2 SDK Reference Bdrive Inc, Copyright Bdrive inc, A Rights Reserved

2 version date e-mai

3 Contents 1 Overview Instaation Instaation Uninstaation To incude header fie and ink ibrary fie API References ND2_INIT ND2_CONNECT ND2_CONNECT_EX ND2_DISCONNECT ND2_DISCONNECT_ALL ND2_SETSIZE ND2_GET_CLOUDUSERNAME ND2_SET_MOVE_FOLDER ND2_GET_CREDENTIAL ND2_REFRESH_CLOUDUSAGE ND2_SET_DRIVESIZE_CALLBACK ND2_SHUTDOWN ND2_SET_SPEEDLIMIT ND2_SET_SPEEDLIMIT_ALL ND2_SET_LOGLEVEL

4 3

5 1 Overview This document describes the about NetDrive 2.6.x SDK Support OS Microsoft Windows 10 Microsoft Windows 8 Microsoft Windows 8.1 Microsoft Windows 7 Microsoft Windows Vista Microsoft Windows XP Microsoft Windows Server 2003/2008/2012 4

6 2 Instaation 2.1 Instaation To insta NetDrive2 SDK, execute foowing command. NetDrive2-SDKsetup.exe /NAME=$ND2_SDK_NAME /INSTDIR=$ND2_SDK_INSTDIR $ND2_SDK_NAME must be a unique your string. ex) NetDrive2_SDK_APP $ND2_SDK_INSTDIR is a path to insta ex) C:\Program Fies\ND2_App Foowing command is an exampe. NetDrive2-SDKsetup.exe /NAME=ND2_EX_APP /INSTDIR= C:\Program Fies\ND2_EX_APP 2.2 Uninstaation To uninsta NetDrive2 SDK, execute foowing command, $PATH is NetDrive2 SDK path. $PATH\ND2SDK_Uninsta.exe 2.3 To incude header fie and ink ibrary fie The header fie and ibrary fie is in NetDrive2 SDK instaed path. Header ibrary nd2api.h nd2api.ib 5

7 3 API References Function ND2_INIT ND2_CONNECT ND2_CONNECT_EX ND2_DISCONNET ND2_DISCONNECT_ALL ND2_SETSIZE ND2_GET_CLOUDUSERNAME ND2_SET_MOVE_FOLDER ND2_GET_CREDENTIAL ND2_REFRESH_CLOUDUSAGE ND2_SET_DRIVESIZE_CALLBACK ND2_SHUTDOWN ND2_SET_SPEEDLIMIT ND2_SET_SPEEDLIMIT_ALL ND2_SET_LOGLEVEL Description Initiates NetDrive2 SDK with seria key Perform mounting a drive Perform mounting with more parameters Perform unmounting a mounted drive Perform unmounting a the mounted drives Updates a tota and free size vaues Get user name of coud storage service Ony for Googe Drive, OneDrive Enabe or disabe to rename,move,deete foder Ony for Amazon S3, Openstack Swift Get credentia information. ony for Googe Drive and OneDrive Refresh free and used space of the mounted drive. Ony for Googe Drive and OneDrive Shutdowns NetDrive2e SDK Perform the speed imit Perform the speed imit Perform the og eve settings 3.1 ND2_INIT BOOL ND2_INIT( LPCSTR pseria ) The ND2_INIT function initiates use of the NetDrive2 API by a process. It must be the first function caed by an appication or DLL pseria : a given seria of NetDrive2 SDK 6

8 Return Vaue If successfu, it returns TRUE. Otherwise it returns FALSE. When ND2_INIT is caed by an appication or D, two nd2mounter.exe are executed. 3.2 ND2_CONNECT INT32 ND2_CONNECT(LPCSTR type, LPCSTR ur, LPCSTR user, LPCSTR pwd, LPCSTR drive, LPCSTR abe ) The ND2_CONNECT function performs mounting a site to a etter. type : The nu terminated string to mount type. Type must be one of supported types. Supported types are beow. type dav ftp sftp s3 gdrive skydrive Description WebDAV connection ftp connection SFTP connection Amazon S3 connection Googe Drive connection OneDrive(SkyDrive) connection ur : A ur to connect. It must be a fu formatted ur incuding scheme, host, path, port Type scheme Description 7

9 dav http A genera HTTP https A HTTP over SSL/TLS ftp ftp A genera FTP ftps A FTP over SSL/TLS sftp sftp ftp over SSH Ex) Ex) ftps:// :21/path user : A user account to connect pwd : A password of user to connect drive : A drive etter to be mounted. Labe : A abe of drive etter to be shown Return Vaue vaue Description 0 Success -100 Not initiaized -1 Drive error -2 Drive etter error -3 Drive insta error -4 Drive start error -5 Mount error 10 Permission denied 11 Connection error 12 Path is not found. The ur to connect must be a fu formatted incuding scheme, host, port and path If both user and password are NULL, it tries to connect anonymous Exampe Code 8

10 ND2_CONNECT( dav, useraccount, password, Z, DAV ) 3.3 ND2_CONNECT_EX INT32 ND2_CONNECT_EX(LPCSTR type, LPCSTR ur, LPCSTR user, LPCSTR pwd, LPCSTR drive, LPCSTR abe, LPCSTR key_fie, LPCSTR user_agent, UINT32 option, PROXY_INFO *pproxyinfo ) The ND2_CONNECT_EX is simiar to ND2_CONNECT. The ND2_CONNECT_EX is added detaied parameters. key_fie : If type is sftp, this pamameter is a private key fie path on sftp connection. if type is gdrive or skydrive, this parameter is a string of credentia getting by ND2_GET_CREDENTIAL function. Otherwise this parameter is ignored. user_agent : A NULL terminated string to be User-agent vaue of HTTP header. This parameter is vaid if type is dav, otherwise ignored. Maximum ength of user_agent is 512. option : A combination vaue of foowing. defined vaue Description NETWORK_DRIVE 0x Mount as a oca drive LOCAL_DRIVE 0x Moust as a network drive SFTP_HOME 0x Mount point is a home directory of user. This is vaid if type is sftp, otherwise ignored SFTP_ROOT 0x Mount point is a root directory of system. This is vaid if type is sftp, otherwise ignored. UNMOUNT_KILLED 0x Unmount virtua drive when the mounting process is kied DON T_UNMOUNT_KILLED 0x Don t unmount virtua drive 9

11 even if the mounting process is kied HTTP_COMPRESS_GZIP 0x If type is dav, Acceptencoding: gzip is added to http request header. FTP_PASSIVE 0x Use passive mode ftp transfer FTP_ACTIVE 0x Use active mode ftp transfer pproxyinfo : Proxy Information. A pointer of PROXY_INFO structure. It contains proxy host, port, user account and password. Return Vaue Same with ND2_CONNECT Same with ND2_CONNECT Exampe Code ND2_CONNECT_EX( dav, useraccount, password, Z, DAV, NULL, netdrive2 sdk webdav cient, 0x00 ) 3.4 ND2_DISCONNECT INT32 ND2_DISCONNECT( LPCSTR drive ) The ND2_DISCONNECT function performs unmounting a mounted drive 10

12 drive : A NULL terminated string containing drive etter Return Vaue If successfu, the ND2_DISCONENCT returns 0. otherwise it returns ND2_DISCONNECT_ALL BOOL ND2_DISCONNECT_ALL() The ND2_DISCONNECT_ALL function perform unmounting a the mounted drives. Return Vaue If successfu, the ND2_DISCONNECT_ALL returns 1, otherwise it returns ND2_SETSIZE INT32 ND2_SETSIZE( LPCSTR drive, int64 tota, int64 free ) The ND2_SETSIZE function updates tota and free size vaues of drive drive : a drive etter to be set size tota : tota bytes size of drive free : free bytes size of drive 11

13 Return Vaue If successfu, the ND2_SETSIZE returns 0, otherwise ND2_GET_CLOUDUSERNAME BOOL ND2_GET_CLOUDUSERNAME( char *pdrive, wchar_t **pname) Get user name of coud service. pdrive : a mounted drive etter pname (out) : a buffer of user name to be gotten Return Vaue If successfu, the ND2_GET_CLOUDUSERNAME returns TRUE, otherwise FALSE. This function is vaid ony for gdrive and skydrive 3.8 ND2_SET_MOVE_FOLDER void ND2_SET_MOVE_FOLDER( char *pdrive, int32 fag ) The ND2_SET_MOVE_FOLDER function makes enabe or disabe to rename,move and deete foder of a mounted drive. 12

14 pdrive : a mounted drive etter to make enabe or disabe to rename, move and deete foder fag : 1 make enabe to rename, move and deete foder. 0 make disabe. This function is vaid ony for s3 and swift drive type. A time out coud be occurred when a foder is renamed or moved or deeted because of features of s3 and swift. 3.9 ND2_GET_CREDENTIAL BOOL ND2_GET_CREDENTIAL( char *pdrive, char **cred ) The ND2_GET_CREDENTIAL function gets the credentia information of Googe Drive connection or OneDrive connection. This function is vaid ony for gdrive and skydrive pdrive : a mounted drive etter to get credentia information cred: output buffer to get credentia information Return Vaue If successfu, the ND2_GET_CREDENTIAL returns TRUE, otherwise FALSE. This function is vaid ony for gdrive and skydrive. 13

15 3.10 ND2_REFRESH_CLOUDUSAGE void ND2_REFRESH_CLOUDUSAGE( char *pdrive ) The ND2_REFRESH_CLOUDUSAGE function refresh the free and used space of a mounted drive. pdrive : a mounted drive etter to refresh a mounted drive This function is vaid ony for gdrive and skydrive ND2_SET_DRIVESIZE_CALLBACK BOOL ND2_SET_DRIVESIZE_CALLBACK( ND2_DRIVESIZE_CALLBACK pcaback ) ND2_SET_DRIVESIZE_CALLBACK function sets the caback function. pcaback : the caback function pointer This caback function is caed when the fie system of NetDrive needs the size of drive. The type of ND2_DRIVESIZE_CALLBACK is foowing. typedef BOOL(*ND2_DRIVESIZE_CALLBACK)( char *pdrive, int64 *tota, int64 *free ); 14

16 3.12 ND2_SHUTDOWN void ND2_SHUTDOWN() void ND2_SHUTDOWN() ND2_SHUTDOWN function ends the use of API functions NetDrive2 SDK. If ND2_SHUTDOWN is caed, the functions of NetDrive2 SDK cannot be used any more ND2_SET_SPEEDLIMIT void ND2_SET_SPEEDLIMIT(char *pdrive, int64 speed ) ND2_SET_SPEEDLIMIT function imits the transfer speed of the specified mounted drive. pdrive : the drive etter to imit the transfer speed. speed : the speed bytes per second to imit. if the vaue is 0, the speed is not imited ND2_SET_SPEEDLIMIT_ALL void ND2_SET_SPEEDLIMIT( int64 speed ) 15

17 ND2_SET_SPEEDLIMIT_ALL function imits the transfer speed of the a mounted drive. speed : the speed bytes per second to imit. if the vaue is 0, the speed is not imited ND2_SET_LOGLEVEL void ND2_SET_LOGLEVEL( char* eve ) ND2_SET_LOGLEVEL function set the og eve of NetDrive. eve : DEBUG or ERROR The og fie is saved in [%PROGRAMDATA%\SDK_NAME\nd2svcog]. ex) C:\ProgramData\NetDrive2\nd2svcog\nd2svc.og 16