Yoctopuce Yocto-GPS, User Manual

Page: 153 / 572

20. High-level API Reference
YAPI YAPI.HandleEvents()
yHandleEvents()
Maintains the device-to-library communication channel.
js
function yHandleEvents( errmsg )
nodejs
function HandleEvents( errmsg )
cpp
YRETCODE yHandleEvents( string& errmsg )
m
+(YRETCODE) HandleEvents :(NSError**) errmsg
pas
function yHandleEvents( var errmsg : string): integer
vb
function yHandleEvents( ByRef errmsg As String) As YRETCODE
cs
YRETCODE HandleEvents( ref string errmsg )
java
int HandleEvents( )
uwp
async Task<int> HandleEvents( )
py
def HandleEvents( errmsg =None)
php
function yHandleEvents( &$errmsg )
es
function HandleEvents( errmsg )
If your program includes significant loops, you may want to include a call to this function to make sure
that the library takes care of the information pushed by the modules on the communication channels.
This is not strictly necessary, but it may improve the reactivity of the library for the following commands.
This function may signal an error in case there is a communication problem while contacting a module.
Parameters :
errmsg a string passed by reference to receive any error message.
Returns :
YAPI_SUCCESS when the call succeeds.
On failure, throws an exception or returns a negative error code.
www.yoctopuce.com 147