BkgName

Description

Returns or sets the name prefix for the background data files.


Syntax

[VB]
objActiveGige.BkgName =[ Value ]

[C/C++]
HRESULT get_BkgName( bstr *pName );
HRESULT put_BkgName( bstr Name );


Data Types [VB]

String

Parameters [C/C++]

pName [out, retval]

Pointer to the string containing the name prefix of the background data files.

Name [in]

The background name prefix to be set.

Return Values

S_OK

Success

E_FAIL

Failure.

Example

The following VB example assigns the name for background files and stores the current image as a dark field:

ActiveGige1.BkgName="MyBackground"
ActiveGige1.SaveBkg (1)

Remarks

Background data are stored as raw image files in the Bkgnd subfolder of ActiveGige program directory (typically C:\Program Files\ActiveGige\Bkgnd). The full name of a background file is composed of the BkgName prefix and substrings indicating the camera index, video mode and background type. E.g., if the background name is assigned as in the example above and the camera operates in the video mode #3, the background image file will be stored under the name "MyBackground_cam0_mode3_dark.raw"