A structure containing the parameters to the file upload/download.
public struct ml_file_transfer_info_w
Member name | Type | Description |
---|---|---|
auth_parms |
wchar_t ** |
Supplies parameters to authentication parameters in MobiLink events. For more information, see Additional Parameters synchronization parameter. |
auth_status |
asa_uint16 |
Supplies parameters to authentication parameters in MobiLink events. For more information, see Additional Parameters synchronization parameter. |
auth_value |
asa_uint16 |
Reports results of a custom MobiLink user authentication script. The MobiLink server provides this information to the client. For more information, see Authentication Value synchronization parameter. |
enable_resume |
bool |
If set to true, MLFileDownload resumes a previous download that was interrupted because of a communications error or because it was canceled by the user. If the file on the server is newer than the partial local file, the partial file is discarded and the new version is downloaded from the beginning. The default is true. |
error |
mlft_stream_error_w |
Contains information about any error that occurs. |
file_auth_code |
asa_uint16 |
Contains the return code of the optional authenticate_file_transfer script on the server. |
filename |
wchar_t * |
The file name to be transferred from the server running MobiLink. MobiLink searches the username subdirectory first, before defaulting to the root directory. For more information, see -ftr mlsrv12 option. |
local_filename |
wchar_t * |
The local name for the downloaded file. If this parameter is empty, the value in file name is used. |
local_path |
wchar_t * |
The local path to store the downloaded file. If this parameter is empty (the default), the downloaded file is stored in the current directory. On Windows Mobile, if dest_path is empty, the file is stored in the root (\) directory of the device. On the desktop, if the dest_path is empty, the file is stored in the user's current directory. |
num_auth_parms |
asa_uint8 |
The number of authentication parameters being passed to authentication parameters in MobiLink events. For more information, see Number of Authentication Parameters parameter. |
observer |
ml_file_transfer_observer_fn |
A callback can be provided to observe file download progress through the 'observer' field. For more details, see description of Callback Function that follows. |
password |
wchar_t * |
The password for the MobiLink user name. |
remote_key |
wchar_t * |
The MobiLink remote key. |
stream |
const char * |
Required. The protocol can be one of: TCPIP, TLS, HTTP, or HTTPS. For more information, see Stream Type synchronization parameter. |
stream_parms |
wchar_t * |
The protocol options for a given stream. For more information, see Network protocol options for UltraLite synchronization streams. |
transfered_file |
asa_uint16 |
1 if the file was successfully transfered and 0 if an error occurs. An error occurs if the file is already up-to-date when MLFileUpload is invoked. In this case, the function returns true rather than false. |
user_data |
void * |
The application-specific information made available to the synchronization observer. For more information, see User Data synchronization parameter. |
username |
wchar_t * |
Required. MobiLink user name. |
version |
wchar_t * |
Required. The MobiLink script version. |
This structure prototype is used internally when you refer to ml_file_transfer_info and #define the UNICODE macro on Win32 platforms. Typically, you would not reference this method directly when creating an UltraLite application.
Discuss this page in DocCommentXchange.
|
Copyright © 2010, iAnywhere Solutions, Inc. - SQL Anywhere 12.0.0 |