Description
-
Creates a new instance of the wodSFTPdll API library.
Return Type
-
A void * value. Handle of the instance. NULL if
error.
Syntax
-
void *Sftp_Create(SftpEventsStruct
*Events, [char *LicenseKey]);
The Create function syntax has these parts:
| SftpEventsStruct *Events |
Pointer to
SftpEventsStruct class that holds callback
information. |
| char
*LicenseKey |
Your license
key. |
Remarks
-
The Sftp_Create function is the first function you should
call when using the wodSFTP library. It initializes an
instance of wodSFTP and returns a handle for the instance.
Once you are done using the instance, you should
destroy it using the Sftp_Destroy
function.
If you intend to use Events (callbacks) in wodSFTP, you
must create an SftpEventsStruct structure and set pointers in
it to the appropriate callback functions - as they are declared
in SftpEventsStructs. We advise that before you
actually use this structure, you clear it using the memset
function. When a struct member is NULL, wodSFTP will
ignore that event and never call it.
If you have purchased copy of the wodSFTP library, then you
must also provide the LicenseKey that you received at the time of purchase. If you do not have such a key, just
leave LicenseKey set to NULL or "".
More information about using events and callbacks can be
found on the Callbacks page.
|