Declaration

Delphi (DLL)
function PromoImageSetOptions(ImageID: integer; Orientation: Integer; Delay: integer; Effect: integer; WParam:DWORD): integer; register;

C/C++ (DLL)
SOPAD_API int SOPAD_PromoImageSetOptions(long ImageID, long Orientation, long Delay, long Efect, long WParam);

ActiveX
HRESULT _stdcall PromoImageSetOptions([in] long ImageID, [in] long Orientation, [in] long Delay, [in] long Efect, [in] long WParam, [out, retval] long* Result);

Description

PromoImageSetOptions caches the promo-screen image settings. you can flash thes settings with PromoImageDoAction( ACTION_UPLOAD). Please note that the device needs some time to load the image from the flash into the memory, this can take about 2 seconds which means a delay timer will not work with values under 2 sec.  This functionally is only available by duraSign Pad Brilliance and 10.0 with newest /wiki/spaces/PUBS/pages/78872625.

Arguments

ImageNumber: integer; 

e.g. promoscreen index [1..n]

ImageOrientation: Integer
resource orientation [0..1]

Delay: integer
timer how long the image should be displayed until next image is loaded. (should be at least 2sec)

Effect: integer
placeholder for possible slide in effects in future devices/firmware versions. 

WParam:DWORD
not used yet

Return value

PromoImageSetOptions returns (SOPAD_ERROR_SUCCESS = 0) if it was possible to cache the settings.
Otherwise the 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

Samples

int ImageOrientation = 0;  //  Landscape Mode
int ImageNumber = 1;
int ImageDelay = 5;

int promoImageSetOptionsStatus = SigDev.PromoImageSetOptions(ImageNumber, ImageOrientation, ImageDelay, 0, 0);