LoggerCaptureScreen


Function

Saves an image of the active window.

Function

Ret = LoggerCaptureScreen ( AppId , WindowNo , ImageArea , FilePath )

Parameters

AppId [ VB.NET: Short ] [ C++: short ] [ C#: short ] 

Specify Application ID retrieved by LoggerOpenApplication.

WindowNo [ VB.NET: UShort ] [ C++: unsigned short ] [ C#: ushort ]

It should be fixed to 0.

ImageArea [ VB.NET: UShort ] [ C++: unsigned short ] [ C#: ushort ]

Specify the image storage area.

Value

[Dec]

Macro

Description

0

LOGGER_PARAM_IMAGE_ENTIRE

Entire C-LOGGER

1

LOGGER_PARAM_IMAGE_GRAPH

Graph window only

FilePath  [ VB.NET: String ] [ C++ : char * ] [ C#: string]

Specify the file name including the file path to save the target data.

If you specify an extension, the file is saved in the corresponding image format.
.png, .jpg, and bmp formats are supported.

Return Value

Ret [ VB.NET: Integer ] [ C++: long ] [ C#: int ]

Definition

Return code

[Dec]

Description

LOGGER_ERR_SUCCESS

0

Normal completed

LOGGER_ERR_FILEPATH

10002

The setting file path is invalid.

LOGGER_ERR_INVALID_ID

10010

Invalid AppId was specified.

LOGGER_ERR_IMAGE_AREA

22501

The image storage range is outside the configurable range.

The others (See also: Error Code List)

Initial Value

Nothing in particular.

Remarks

Saves an image of the active window.

FilePath must end with ".png", ".bmp" or ".jpg".
Otherwise, LOGGER_ERR_FILEPATH (10002) is returned.

Example

Saves only the active graph window to graph_window.png.

VB.NET

Dim Ret As Integer

Ret = LoggerCaptureScreen(AppId, 0, LOGGER_PARAM_IMAGE_GRAPH, "graph_window.png")

 

C++

long Ret;

Ret = LoggerCaptureScreen(AppId, 0, LOGGER_PARAM_IMAGE_GRAPH, "graph_window.png");

 

C#

int Ret;

Ret = logger.CaptureScreen(AppId, 0, LOGGER_PARAM_IMAGE_GRAPH, "graph_window.png");

 

See Also

None