Yoctopuce Yocto-GPS, User Manual

Page: 167 / 572

20. High-level API Reference
YAPI YAPI.TestHub()
yTestHub()
Test if the hub is reachable.
cpp
YRETCODE yTestHub( const string& url , int mstimeout , string& errmsg )
m
+(YRETCODE) TestHub : (NSString*) url
: (int) mstimeout
: (NSError**) errmsg
pas
function yTestHub( url : string,
mstimeout : integer,
var errmsg : string): integer
vb
function yTestHub( ByVal url As String,
ByVal mstimeout As Integer,
ByRef errmsg As String) As Integer
cs
int TestHub( string url , int mstimeout , ref string errmsg )
java
int TestHub( String url , int mstimeout )
uwp
async Task<int> TestHub( string url , uint mstimeout )
py
def TestHub( url , mstimeout , errmsg =None)
php
function yTestHub( $url , $mstimeout , &$errmsg )
es
function TestHub( url , mstimeout )
This method do not register the hub, it only test if the hub is usable. The url parameter follow the same
convention as the
RegisterHub
method. This method is useful to verify the authentication
parameters for a hub. It is possible to force this method to return after mstimeout milliseconds.
Parameters :
url a string containing either "usb","callback" or the root URL of the hub to monitor
mstimeout the number of millisecond available to test the connection.
errmsg a string passed by reference to receive any error message.
Returns :
YAPI_SUCCESS when the call succeeds.
On failure returns a negative error code.
www.yoctopuce.com 161