Ets_Nt_Subnet_Grid_Properties_Get()
Abstract
Retrieves the value of the specified grid property on the ETS subnet object.
Syntax
Ets_Nt_Subnet_Grid_Properties_Get (subnet_hndl, op_code, val_ptr)
| Argument | Type | Description |
|---|---|---|
subnet_hndl |
EtsT_Obj_Handle |
Handle of the object of interest. |
op_code |
EtsT_Nt_Grid_Prop_Op |
Identifies the property to get. |
val_ptr |
void* |
Returns the value of the property. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if the property exists. EtsC_Compcode_Failure otherwise.
Header
ets_api_nt.h
Details
The subnet must be installed in an ETS model in order for the grid properties to be valid.
The op_code specifies which property is to be obtained. The properties and corresponding value data types are listed below.
| Property | Data Type of Value |
|---|---|
EtsC_Nt_Grid_Division_Automatic |
boolean |
EtsC_Nt_Grid_Division_Op |
double |
EtsC_Nt_Grid_Draw_Style_Op |
EtsT_Nt_Grid_Draw_Style |
EtsC_Nt_Grid_Color_Op |
EtsT_Nt_Grid_Draw_Color |
EtsC_Nt_Grid_Resolution_Op |
double |
EtsC_Nt_Grid_Units_Op |
EtsT_Nt_Grid_Unit |
The third argument should be the address of a variable of the appropriate type for the specified property.