SimConnect_CameraAcquire

The SimConnect_CameraAcquire function is used to acquire the add-on camera. Note that the camera may not be immediately useable on acquisition, as it may be under simulation control. Please see the main Camera API page for more information.

 

Syntax

HRESULT SimConnect_CameraAcquire(
    HANDLE  hSimConnect
    );

 

Parameters

Parameter	Description	Type
hSimConnect	Handle to a SimConnect object.	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. If the camera failed to be acquired, SimConnect will raise a SIMCONNECT_EXCEPTION_CAMERA_API exception to let you know that the operation failed (refer to the SIMCONNECT_EXCEPTION enum for more details).

 

Example

HANDLE  hSimConnect = NULL;
SimConnect_CameraAcquire(hSimConnect)

 

Remarks

The sim will send a SIMCONNECT_RECV_CAMERA_STATUS to the client at the end of acquisition which you can use to check the camera has been properly acquired. It's handled through SimConnect_CallDispatch.

 

Report An Issue