SimConnect_RequestAllFacilites

The SimConnect_RequestAllFacilites function is used to request a list of all the facilities of a given type currently in the world depending on the requested type.

 

Syntax

HRESULT SimConnect_RequestAllFacilites(
    HANDLE  hSimConnect,
    SIMCONNECT_FACILITY_LIST_TYPE  type,
    SIMCONNECT_DATA_REQUEST_ID  RequestID
    );

 

Parameters

Parameter	Description	Type
hSimConnect	Handle to a SimConnect object.	Integer
type	Specifies one member of the SIMCONNECT_FACILITY_LIST_TYPE enumeration type.	Enum
RequestID	Specifies the client defined request ID. This will be returned along with the data.	Integer

 

Return Values

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

Return value	Description
S_OK	The function succeeded.
E_FAIL	The function failed.

 

Remarks

This function returns the entire list of facilities, no matter the distance to each elements. To retrieve information about facilities around you, use functions such as SimConnect_RequestFacilitiesList_EX1 or SimConnect_SubscribeToFacilities_EX1.

 

When requesting types of facility information, one function call has to be made for each of the four types of data. The data will be returned in one of the four structures:

• SIMCONNECT_RECV_AIRPORT_LIST, which will contain a list of SIMCONNECT_DATA_FACILITY_AIRPORT structures.
• SIMCONNECT_RECV_NDB_LIST, which will contain a list of SIMCONNECT_DATA_FACILITY_NDB structures.
• SIMCONNECT_RECV_VOR_LIST, which will contain a list of SIMCONNECT_DATA_FACILITY_VOR structures.
• SIMCONNECT_RECV_WAYPOINT_LIST, which will contain a list of SIMCONNECT_DATA_FACILITY_WAYPOINT structures.

The four list structures inherit the data from the SIMCONNECT_RECV_FACILITIES_LIST structure. Given that the list of returned facilities could be large, it may be split across several packets, and each packet must be interpreted separately by the client.

 

See Also

• SimConnect API Reference