Yoctopuce Yocto-GPS, User Manual

Page: 155 / 572

20. High-level API Reference
YAPI YAPI.PreregisterHub()
yPreregisterHub()
Fault-tolerant alternative to RegisterHub().
js
function yPreregisterHub( url , errmsg )
nodejs
function PreregisterHub( url , errmsg )
cpp
YRETCODE yPreregisterHub( const string& url , string& errmsg )
m
+(YRETCODE) PreregisterHub :(NSString *) url :(NSError**) errmsg
pas
function yPreregisterHub( url : string, var errmsg : string): integer
vb
function yPreregisterHub( ByVal url As String,
ByRef errmsg As String) As Integer
cs
int PreregisterHub( string url , ref string errmsg )
java
int PreregisterHub( String url )
uwp
async Task<int> PreregisterHub( string url )
py
def PreregisterHub( url , errmsg =None)
php
function yPreregisterHub( $url , &$errmsg )
es
function PreregisterHub( url , errmsg )
This function has the same purpose and same arguments as RegisterHub() , but does not trigger
an error when the selected hub is not available at the time of the function call. This makes it possible to
register a network hub independently of the current connectivity, and to try to contact it only when a
device is actively needed.
Parameters :
url a string containing either "usb","callback" or the root URL of the hub to monitor
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 149