SimConnect_AddToFacilityDefinition

The SimConnect_AddToFacilityDefinition function is used to create a facility data definition.

Syntax#

HRESULT SimConnect_AddToFacilityDefinition(
    HANDLE hSimConnect,
    SIMCONNECT_DATA_DEFINITION_ID DefineID,
    const char * FieldName
    );

Parameters#

Return Values#

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

It is also possible that the following Exception IDs will be received:

• SIMCONNECT_EXCEPTION_UNRECOGNIZED_ID - An invalid DefineID has been supplied.
• SIMCONNECT_EXCEPTION_DATA_ERROR - An invalid FieldName has been supplied.

Remarks#

This is used to add a new field to a client defined object definition in order to retrieve information. Using this function will require multiple calls and these calls will need to be formatted in a very specific way, initially using one of the four available entry points:

• AIRPORT
• WAYPOINT
• NDB
• VOR

Each entry point will need to be prefixed with “OPEN " before any data is requested, and then prefixed with “CLOSED " to end the data retrieval, and this format works for the different child members of these entry points. For example:

SimConnect_AddToFacilityDefinition(hSimConnect, FACILITY_DATA_DEF_AIRPORT, "OPEN AIRPORT");
// Request further airport data
SimConnect_AddToFacilityDefinition(hSimConnect, FACILITY_DATA_DEF_AIRPORT, "CLOSE AIRPORT");
SimConnect_AddToFacilityDefinition(hSimConnect, FACILITY_DATA_DEF_AIRPORT, "OPEN NDB");
// Request further NDB data
SimConnect_AddToFacilityDefinition(hSimConnect, FACILITY_DATA_DEF_AIRPORT, "CLOSE NDB");
// etc...

Essentially, for every member that you open you must have a corresponding close, otherwise you will have an error. Note too that after defining the data that you want to retrieve, you will need to call SimConnect_RequestFacilityData to finalise and send the request.

At the bottom of this page you can find information on each of the entry points and the different members and children that they can contain, and if you expand the text below, you can find a schema showing the hierarchy of members and children within the returned data.

!

Note that results may be filtered using the SimConnect_AddFacilityDataDefinitionFilter function, ensuring that you receive less data, and that the data is relevant.

Example#

SIMCONNECT_DATA_DEFINITION_ID FACILITY_DATA_DEF_AIRPORT = 123;
{
    // Entry point will be an Airport
    SimConnect_AddToFacilityDefinition(hSimConnect, FACILITY_DATA_DEF_AIRPORT, "OPEN AIRPORT");
    
    // Add some airport members
    SimConnect_AddToFacilityDefinition(hSimConnect, FACILITY_DATA_DEF_AIRPORT, "A");
    SimConnect_AddToFacilityDefinition(hSimConnect, FACILITY_DATA_DEF_AIRPORT, "B");
    SimConnect_AddToFacilityDefinition(hSimConnect, FACILITY_DATA_DEF_AIRPORT, "C");
    
    // Runway is a child of Airport, so we can request them in Airport FacilityDataDefinition
    SimConnect_AddToFacilityDefinition(hSimConnect, FACILITY_DATA_DEF_AIRPORT, "OPEN RUNWAY");
    
    // Add some runway members
    SimConnect_AddToFacilityDefinition(hSimConnect, FACILITY_DATA_DEF_AIRPORT, "a");
    SimConnect_AddToFacilityDefinition(hSimConnect, FACILITY_DATA_DEF_AIRPORT, "b");
    
    // We requested every thing we want about runway, so "close" it to get back to Airport Definition
    SimConnect_AddToFacilityDefinition(hSimConnect, FACILITY_DATA_DEF_AIRPORT, "CLOSE RUNWAY");
    
    // We requested every thing we want about airport, so "close" it.
    SimConnect_AddToFacilityDefinition(hSimConnect, FACILITY_DATA_DEF_AIRPORT, "CLOSE AIRPORT");
    
    // Request data from Airport LFPG which will follow the format defined earlier.
    SimConnect_RequestFacilityData(hSimConnect, FACILITY_DATA_DEF_AIRPORT, 123, "LFPG");
}

In the example given above, we have created a facility data definition which will request members “A”, “B”, and “C” of an airport and members “a” and “b” of each runway for the airport with ICAO “LFPG” (which has four runways). You should receive back from this the following:

• A message about Airport data \[A, B, C\]
• 4 messages about runway data \[a, b\]

So, imagine we complete an example request like the one above and each runway has a child with members “1”, “2”, and “3”. In that case you would receive back the following data:

[A, B, C] [a, b] [1, 2, 3] [a, b] [1, 2, 3] [a, b] [1, 2, 3] [a, b] [1, 2, 3]

See Also#

• SimConnect API Reference
• SimConnect_RequestFacilityData
• SimConnect_RequestFacilitesList

AIRPORT#

For the airport entry point you can request the following information directly:

TAXI_NAME#

This is a child member of the AIRPORT entry point and you can request the following data from it:

TAXI_PATH#

This is a child member of the AIRPORT entry point and you can request the following data from it:

TAXI_PARKING#

This is a child member of the AIRPORT entry point and you can request the following data from it:

AIRLINE#

This is a child member of the TAXI_PARKING entry point and you can request the following data from it:

TAXI_POINT#

This is a child member of the AIRPORT entry point and you can request the following data from it:

HELIPAD#

This is a child member of the AIRPORT entry point and you can request the following data from it:

FREQUENCY#

This is a child member of the AIRPORT entry point and you can request the following data from it:

JETWAY#

This is a child member of the AIRPORT entry point and you can request the following data from it:

VDGS#

This is a child member of the AIRPORT entry point and you can request the following data from it:

HOLDING_PATTERN#

This is a child member of the AIRPORT entry point and you can request the following data from it:

ARRIVAL#

This is a child member of the AIRPORT entry point, and is itself an entry point for the RUNWAY_TRANSITION, ENROUTE_TRANSITION, and APPROACH_LEG structs.

In addition to the member structs listed above, you can get more data using the following member parameters:

RUNWAY_TRANSITION#

This is a child member of the DEPARTURE and ARRIVAL entry points and is itself an entry point for the APPROACH_LEG struct.

In addition to the member struct listed above, you can get more data using the following member parameters:

ENROUTE_TRANSITION#

This is a child member of the DEPARTURE and ARRIVAL entry points and is itself an entry point for the APPROACH_LEG struct.

In addition to the member struct given above, you can get more data using the following member parameters:

DEPARTURE#

This is a child member of the AIRPORT entry point, and is itself an entry point for RUNWAY_TRANSITION, ENROUTE_TRANSITION, and APPROACH_LEG structs.

In addition to the member structs listed above, you can get more data using the following member parameters:

APPROACH#

This is a child member of the AIRPORT entry point, and is itself an entry point for the APPROACH_TRANSITION, FINAL_APPROACH_LEG, and MISSED_APPROACH_LEG structs.

In addition to the member structs listed above, you can get more data using the following member parameters:

Member Name

DataType

Description

TYPE

INT32

The approach type. Can be one of the following values:

1. 0: UNDEFINED
2. 1: GPS
3. 2: VOR
4. 3: NDB
5. 4: ILS
6. 5: LOCALIZER
7. 6: SDF
8. 7: LDA
9. 8: VORDME
10. 9: NDBDME
11. 10: RNAV
12. 11: LOCALIZER_BACK_COURSE

SUFFIX

INT32

The multiple indicator suffix (must be converted to Char Alphanumeric or blank).

RUNWAY_NUMBER

INT32

The number of the runway this approach is for, one of the following values:

1. 0: NONE
2. 1 - 36: RUNWAY ID
3. 37: NORTH
4. 38: NORTHEAST
5. 39: EAST
6. 40: SOUTHEAST
7. 41: SOUTH
8. 42: SOUTHWEST
9. 43: WEST
10. 44: NORTHWEST
11. 45: LAST

RUNWAY_DESIGNATOR

INT32

The Designator of the runway this approach is for, one of the following values:

1. 0: NONE
2. 1: LEFT
3. 2: RIGHT
4. 3: CENTER
5. 4: WATER
6. 5: A
7. 6: B
8. 7: LAST

FAF_ICAO

STRING8

Final approach fix ICAO.

FAF_REGION

STRING8

Final approach fix region

FAF_HEADING

FLOAT32

Final approach fix heading, in degrees.

FAF_ALTITUDE

FLOAT32

Final approach fix altitude, in Meters.

FAF_TYPE

INT32

The final approach type, one of the following:

1. 65 (‘A’) - Airport
2. 86 (‘V’) - VOR
3. 78 (‘N’) - NDB
4. 87 (‘W’) - Waypoint

(Note that this will have to be cast as a char)

MISSED_ALTITUDE

FLOAT32

Altitude of the first leg of the Missed approach, in ft.

HAS_LNAV

INT32

Returns whether the approach has lateral navigation (1) or not (0).

HAS_LNAVVNAV

INT32

Returns whether the approach has lateral and vertical navigation (1) or not (0).

HAS_LP

INT32

Returns whether the approach has localizer performance (1) or not (0).

HAS_LPV

INT32

Returns whether the approach has localizer performance with vertical guidance (1) or not (0).

IS_RNPAR

INT32

Returns whether the approach is RNP-AR [1] or not [0].

IS_RNPAR_MISSED

INT32

Returns whether the missedapproach is RNP-AR [1] or not [0].

N_TRANSITIONS

INT32

The number of APPROACH_TRANSITIONs for the approach.

N_FINAL_APPROACH_LEGS

INT32

The number of FINAL_APPROACH_LEG for the approach.

N_MISSED_APPROACH_LEGS

INT32

The number of MISSED_APPROACH_LEG the approach.

APPROACH_TRANSITION

STRUCT: APPROACH_TRANSITION

Contains approach transition data.

FINAL_APPROACH_LEG

STRUCT: FINAL_APPROACH_LEG

Contains the final approach leg data.

MISSED_APPROACH_LEG

STRUCT: MISSED_APPROACH_LEG

Contains the missed approach leg data.

APPROACH_TRANSITION#

This is a child member of the APPROACH entry point, and is itself an entry point for the APPROACH_LEG struct.

In addition to the member struct given above, you can get more data using the following member parameters:

APPROACH_LEG#

FINAL_APPROACH_LEG#

MISSED_APPROACH_LEG#

This is a child member of the APPROACH, APPROACH_TRANSITION, RUNWAY_TRANSITION, ENROUTE_TRANSITION, DEPARTURE and ARRIVAL entry points, and has the following available data:

START#

This is a child member of the AIRPORT entry point and you can request the following data from it:

RUNWAY#

This is a child member of the AIRPORT entry point and you can request the following data from it:

PAVEMENT#

This is a child member of the RUNWAY entry point - specifically from the PRIMARY_THRESHOLD, PRIMARY_BLASTPAD, PRIMARY_OVERRUN, SECONDARY_THRESHOLD, SECONDARY_BLASTPAD, and SECONDARY_OVERRUN members - and you can request the following data from it:

APPROACHLIGHTS#

This is a child member of the RUNWAY entry point - specifically from the PRIMARY_APPROACH_LIGHTS and SECONDARY_APPROACH_LIGHTS members - and you can request the following data from it:

VASI#

This is a child member of the RUNWAY entry point - specifically from the PRIMARY_LEFT_VASI, PRIMARY_RIGHT_VASI, SECONDARY_LEFT_VASI, and SECONDARY_RIGHT_VASI members - and you can request the following data from it:

WAYPOINT#

The waypoint entry point can have the ROUTE child member and you can request the following information directly:

ROUTE#

This is a child member of the WAYPOINT entry point and you can request the following data from it:

NDB#

The NDB entry point can request the following information:

VOR#

The VOR entry point can request the following information: