Methods > Settings > SetBackPictureFromFile method

Remarks

Sets a background picture from a graphic file.

Syntax

[Visual Basic]

Public Function SetBackPictureFromFile (

strPathname as String,

[C#]

public enumWanErrorCodes SetBackPictureFromFile (

string strPathname,

);

[C++]

public: enumWanErrorCodes SetBackPictureFromFile (

string strPathname,

);

Parameter

Description

strPathname

Absolute pathname of the picture file to load. Accepted graphic formats are BMP, JPEG, GIF, TIFF and PNG.

An empty pathname will reset an eventual picture set through a previous call to this method.

nMode

Bitmap mode.

Supported values are the following:

Mnemonic constant	Value	Meaning
BITMAP_MODE_TOP_LEFT	0	Bitmap will be drawn in top-left position on the destination rectangle
BITMAP_MODE_CENTER	1	Bitmap will be drawn in centered position on the destination rectangle
BITMAP_MODE_STRETCH	2	Bitmap will be stretched in order to fit the destination rectangle
BITMAP_MODE_TILE	3	Bitmap will be tiled in order to fill the destination rectangle

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumWanErrorCodes.ERR_WAN_NOERROR (0)	The method call was successful.