DownloadPadResourceFileByName

Declaration

Delphi (DLL)

function DownloadPadResourceFileByName(ResourceName: ShortString; FilePathOrData: PAnsiChar; WParam:DWORD; LParam:DWORD): integer; register;

C/C++ (DLL)

SOPAD_API int SOPAD_DownloadPadResourceFileByName(char *ResourceName, char* FilePathOrData, DWORD WParam, DWORD LParam);

ActiveX

HRESULT _stdcall DownloadPadResourceFileByName([in] BSTR ResourceName, [in] long WParam, [in] long LParam, [in] BSTR FilePathOrData, [out, retval] long* Result);

Description

DownloadPadResourceFileByName downloads an specific resource file from the pad to the computer.

Arguments

ResourceName

Name of the file you want to download from the device, for example "PromoScreen1.soi". You can read the file list with the function GetPadResourceFileList

WParam

0: resource will be handled as Image (supported image types: BMP, JPEG and PNG)
1: resource will be handled as a binary/text file

LParam

placeholder without functionality

FilePathOrData

Place where the file should be stored on the harddisc

Return value

DownloadPadResourceFileByName returns (SOPAD_ERROR_SUCCESS = 0) if it was possible to download the resource from the signature device. If downloding hasn't been started, function returns the appropriate error code. You can get extended error code with the help of GetSOPadError call.

Possible error codes are listed below: Driver error codes

See also

DownloadPadResourceFileByName

GetPadResourceFileInfoByName

GetPadResourceFileList

PromoImageOptionsDoAction

PromoImageSetOptions

RemovePadResourceFileByName

RenamePadResourceFileName

Sample

C#
//  Download the Promoscreen1 from the device, the image will be converted from SOI to BMP
 
int downloadStatus = -1;
string filePath = @"c:\temp\Promoscreen1.bmp";
downloadStatus = SigDev.DownloadPadResourceFileByName("PromoScreen.soi",filePath, 0, 0);