Ets_Nt_Subnet_View_Coords_Get()
Abstract
Returns the view area for the specified ETS subnet object.
Syntax
Ets_Nt_Subnet_View_Coords_Get (subnet_hndl, ul_x_ptr, ul_y_ptr, lr_x_ptr, lr_y_ptr)
| Argument | Type | Description |
|---|---|---|
subnet_hndl |
EtsT_Obj_Handle |
Handle of the object of interest. |
ul_x_ptr |
double* |
Returns the x value of the upper-left coordinate of the view. |
ul_y_ptr |
double* |
Returns the y value of the upper-left coordinate of the view. |
lr_x_ptr |
double* |
Returns the x value of the lower-right coordinate of the view. |
lr_y_ptr |
double* |
Returns the y value of the lower-right coordinate of the view. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if the object is a subnet and view coordinates are set on the object. EtsC_Compcode_Failure otherwise.
Header
ets_api_nt.h
Details
The view coordinates define the area of the map to be displayed initially when a user descends into a subnet. The specified coordinates must be within the subnet bounds.