DLL Function

int CCI_Return = ScSetStringValue(int Value_Type, string Screenshot_Path)

ASCII Function

int CCI_Return = ScCciSetStringValue(int Value_Type, string Screenshot_Path)

Description

Make a screenshot of the current View2D.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlStringValueTypeSaveView2D160

6

The width of the screenshot is set to 160 pixel. [*]

scComSAMLightClientCtrlStringValueTypeSaveView2D320

7

The width of the screenshot is set to 320 pixel. [*]

scComSAMLightClientCtrlStringValueTypeSaveView2DVariableSize

8

The width of the screenshot is defined by SaveView2DBitmapVariableSize. [*]

scComSAMLightClientCtrlStringValueTypeSaveView2DFull

9

Size of the screenshot is 1:1 from the current View2D.

Screenshot_Path

Type: string

Unit: none

Defines the path, where the screenshot is saved to. The path must include the file extension, which can be ".bmp" or ".png".

CCI_Return

Type: int

CCI error number, see error list.

Notes

•[*]: The larger axis (usually x) is set to a fixed value, the aspect ratio is kept.

•The screenshot contains the section of the current View2D.

•The screenshot is colored.

•There are several possibilities to control the pixel size of the screenshot.

•This CCI command only works if SAMLight is not minimized.

•The current View2D can be changed via CCI, see Change View2D.

C# Example: Make a 1:1 screenshot of current View2D:

int CCI_Return = cci.ScSetStringValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlStringValueTypeSaveView2DFull, @"F:\screenshot.bmp" );

DLL Function

int CCI_Return = ScSetDoubleValue(int Value_Type, double Width)

double Width = ScGetDoubleValue(int Value_Type)

ASCII Function

int CCI_Return = ScCciSetDoubleValue(int Value_Type, double Width)

double Width = ScCciGetDoubleValue(int Value_Type)

Description

Set or get the screenshot width that is created with SaveView2DVariableSize.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueTypeSaveView2DBitmapVariableSize

81

Width

Type: double

Unit: [mm]

Width of the screenshot [pixel]

CCI_Return

Type: int

CCI error number, see error list.

Notes

The larger axis (usually x) is set to a fixed value, the aspect ratio is kept.

C# Example: Set screenshot width to 640 pixel:

int CCI_Return = cci.ScSetDoubleValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeSaveView2DBitmapVariableSize, 640.0 );

C# Example: Get screenshot width:

double Screenshot_Size = cci.ScGetDoubleValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeSaveView2DBitmapVariableSize );