Logo
Tech Note 2148: NetMotion Mobility Client API

NetMotion Mobility Client API

Technical Note 2148

Last Reviewed 10-Feb-2010
Applies To

Mobility XE versions 5.0 to 8.51 (certain functions apply only to 8.0 and above)
 Printer-friendly version

Summary

The Mobility client API allows your custom application to query and control the Mobility client. The API library is included in all client installations beginning with Mobility 5.0, with Visual Basic support added in 6.01. The default installation location is Windows\System32\Nmclapi.dll. If you plan to use the API, we recommend that you upgrade your clients to the latest version of Mobility.

Note: For Mobility XE versions 9.0 and above refer to the System Administrators Guide for additional Functions and sample files.

Functions

The functions listed below are supported for C/C++ and Visual Basic applications. Details regarding how they work and what they return are listed in nmclapi.h (C/C++) and nmclapisample.vb (VB), which are both included in this zip file: nmclapisample.zip. Nmclapisample.zip also contains some C/C++ and Visual Basic code examples.

Description

 

Function name

Bypasses NetMotion Mobility, depending on the state of the connection.

C/C++

NetMotionBypass

VB

NetMotionBypassVB

Enables NetMotion Mobility, except if it is not loaded.

C/C++

NetMotionEnable

VB

NetMotionEnableVB

Returns the IP address and port of the Mobility server to which the Mobility client is actually connected.

C/C++

NetMotionGetConnectedServerAddress

VB

NetMotionGetConnectedServerAddressVB

Returns the connection state of the client.

C/C++

NetMotionGetConnectionState

VB

NetMotionGetConnectionStateVB

Returns the point-of-presence (local) IP address, in network byte order.

C/C++

NetMotionGetPointOfPresence

VB

NetMotionGetPointOfPresenceVB

Returns the details about the current point-of-presence, such as the interface name and speed.

C/C++

NetMotionGetPointOfPresenceDetails

VB

NetMotionGetPointOfPresenceDetailsVB

Returns the Mobility server IP address and port for which the client is configured, in network byte order. If Mobility is not loaded, the address is obtained from the Windows registry.

C/C++

NetMotionGetServerAddress

VB

NetMotionGetServerAddressVB

Returns Mobility client version number in unsigned long: major and minor version numbers, and build number.

C/C++

NetMotionGetVersion

VB

NetMotionGetVersionVB

Returns the Mobility virtual IP address, in network byte order.

C/C++

NetMotionGetVirtualAddress

VB

NetMotionGetVirtualAddressVB

Causes a specified event to be signaled when the state of Mobility changes.

C/C++

NetMotionNotifyStateChange

Instructs the Mobility client to begin using a different Mobility server address.

C/C++

NetMotionSetServerAddress

VB

NetMotionSetServerAddressVB

Version 8.0 and up only. Sets the specified policy external condition to the specified value. External conditions can be used to trigger policy actions from sources outside of Mobility. For example, an administrator could supply a GPS application which periodically set "lat" and "long" external conditions, whose values would alter the behavior of the Mobility policy applied on the client to allow or disallow certain kinds of traffic depending on the device's location.

C/C++

NetMotionSetExternalCondition

VB

NetMotionSetExternalConditionVB

Version 8.0 and up only. Dis/reconnects the Mobility client and forces the user to reenter his/her credentials.

C/C++

NetMotionLogoff

VB

NetMotionLogoffVB

Related Information

9979

NetMotion Mobility Technical Notes

Please comment on this technical note.