Yoctopuce Yocto-RangeFinder, User Manual, Page: 275 / 497

21. High-level API Reference
YRangeFinder rangefinder
→
load()
Preloads the range finder cache with a specified validity duration.
js
function load( msValidity )
cpp
YRETCODE load( int msValidity )
m
-(YRETCODE) load : (int) msValidity
pas
function load( msValidity : integer): YRETCODE
vb
function load( ByVal msValidity As Integer) As YRETCODE
cs
YRETCODE load( ulong msValidity )
java
int load( long msValidity )
py
def load( msValidity )
php
function load( $msValidity )
es
function load( msValidity )
By default, whenever accessing a device, all function attributes are kept in cache for the standard
duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in
order to reduce network traffic for instance.
Parameters :
msValidity an integer corresponding to the validity attributed to the loaded function parameters, in
milliseconds
Returns :
YAPI_SUCCESS when the call succeeds.
On failure, throws an exception or returns a negative error code.
www.yoctopuce.com 269