Ets_Nt_Subnet_Image_Capture()
Abstract
Captures a graphical image of a subnet.
Syntax
Ets_Nt_Subnet_Image_Capture (subnet_handle, ul_x, ul_y, lr_x, lr_y, image_pixel_width, image_type, image_export_path)
| Argument | Type | Description |
|---|---|---|
subnet_hndl |
EtsT_Obj_Handle |
Subnet of interest. |
ul_x |
double |
x coordinate of upper-left corner, in the units of the subnet. |
ul_y |
double |
y coordinate of upper-left corner, in the units of the subnet. |
lr_x |
double |
x coordinate of lower-right corner, in the units of the subnet. |
lr_y |
double |
y coordinate of lower-right corner, in the units of the subnet. |
image_pixel_width |
int |
Width of the captured image, in pixels (the height is scaled proportionately). |
image_type |
EtsT_Image_Export_Type |
Format of the captured image (see image_type). |
image_export_path |
const char * |
Location of the saved image. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if the subnet exists; EtsC_Compcode_Failure otherwise.
Header
ets_api_nt.h
Details
This function captures a graphical image of a subnet as it would appear in the workspace. You must specify the upper-left and lower-right corners of the part of the subnet wanted in the image and the width of the resulting image. Use Ets_Nt_Model_Visible_Bounds_Get() to get the size of the current subnet view.
To capture a subnet image with more control over how it is captured, including the option to generate HTML, see Ets_Nt_Subnet_Image_Capture_Core().
image_type
image_type must be one of the following constants:
EtsC_Image_Export_Type_GIFEtsC_Image_Export_Type_TIFFEtsC_Image_Export_Type_PNG