winIDEA SDK
Loading...
Searching...
No Matches
isys::WinIDEAInstanceInfo Class Reference

This class contains information about instance of winIDEA as returned by enumeration. More...

#include <ConnectionMgr.h>

Public Member Functions

std::string getInstanceId () const
 Returns instanceId.
int getTcpPort () const
 Returns TCP port.
std::string getWorkspace () const
 Returns workspace path.

Detailed Description

This class contains information about instance of winIDEA as returned by enumeration.

See also
ConnectionMgr::enumerateWinIDEAInstances

Member Function Documentation

◆ getInstanceId()

std::string isys::WinIDEAInstanceInfo::getInstanceId ( ) const
inline

Returns instanceId.

>>> cmgr = ic.ConnectionMgr() >>> cc = ic.CConnectionConfig() >>> instances = ic.VectorWinIDEAInstanceInfo() >>> cmgr.connect(cc.instanceId('sdk_example_winIDEA_ID')) >>> cmgr.enumerateWinIDEAInstances('', cc, instances) >>> instances[0].getInstanceId() 'sdk_example_winIDEA_ID'

Since
9.12.288

◆ getTcpPort()

int isys::WinIDEAInstanceInfo::getTcpPort ( ) const
inline

Returns TCP port.

>>> cmgr = ic.ConnectionMgr() >>> cc = ic.CConnectionConfig() >>> instances = ic.VectorWinIDEAInstanceInfo() >>> cmgr.connect(cc) >>> cmgr.enumerateWinIDEAInstances('', cc, instances) >>> instances[0].getTcpPort() 5315

Since
9.12.288

◆ getWorkspace()

std::string isys::WinIDEAInstanceInfo::getWorkspace ( ) const
inline

Returns workspace path.

>>> cmgr = ic.ConnectionMgr() >>> cc = ic.CConnectionConfig() >>> instances = ic.VectorWinIDEAInstanceInfo() >>> cmgr.connect(cc.instanceId('sdk_example_winIDEA_ID')) >>> cmgr.enumerateWinIDEAInstances('', cc, instances) >>> type(instances[0].getWorkspace()) <class 'str'>

Since
9.12.288