Table of Contents
Advertisement
Overview
This chapter takes users through some of the most commonly-used API
functions that can be used to access and configure the RCM KVM over IP
Transmitters based on 32-bit/64-bit Windows Dynamic-link Library (DLL).
Note: For a complete list of the RCM API functions and/or the DLL-related
materials available, please contact your local dealer.
Starting an API Session
Before implementing an API function to the RCM device, the user must first
start an API session by entering the following:
StartSession(<IP address>,1,<username>,<password>)
Example:
StartSession(192.168.0.60,1,administrator,password)
Then press [Enter].
The ID of the API session — SID — is returned, which is needed for
implementing any API function to the device via the session:
Example:
4
Note: A return value < 0 indicates an error. Please refer to the Error Code
Specification document for the details of the errors represented, or look
up its related description by using the error description search function,
see Error Description Search, page 53.
To end the API session, type the following then press [Enter]:
EndSession(<SID>)
Example:
EndSession(4)
0 is returned, representing the successful termination of the API session.
Chapter 3
API Functions
49
Advertisement
Table of Contents
