winIDEA SDK
IConnect Struct Reference

Description

The IConnect interface provides functions that control connection to winIDEA.

If you use the CIConnectClient class you don't need to use this interface.

#include <i_Connect.h>

Inherits IUnknown.

Public Types

enum  EDetachFlags {
  dfCloseServerIfLastClient = isys::IConnect::EDetachFlags::dfCloseServerIfLastClient , dfCloseServerUnconditional = isys::IConnect::EDetachFlags::dfCloseServerUnconditional ,
  dfCloseServerMask = isys::IConnect::EDetachFlags::dfCloseServerMask , dfCloseAutoSaveDefault = isys::IConnect::EDetachFlags::dfCloseAutoSaveDefault ,
  dfCloseAutoSaveAll = isys::IConnect::EDetachFlags::dfCloseAutoSaveAll , dfCloseAutoSaveNone = isys::IConnect::EDetachFlags::dfCloseAutoSaveNone ,
  dfCloseAutoSaveMask = isys::IConnect::EDetachFlags::dfCloseAutoSaveMask
}
 
enum  ELaunchFlags {
  lfStartNever = isys::IConnect::ELaunchFlags::lfStartNever , lfStartIfRequired = isys::IConnect::ELaunchFlags::lfStartIfRequired ,
  lfStartAlways = isys::IConnect::ELaunchFlags::lfStartAlways , lfStartExisting = isys::IConnect::ELaunchFlags::lfStartExisting ,
  lfStartEnumerate = isys::IConnect::ELaunchFlags::lfStartEnumerate , lfStartMask = isys::IConnect::ELaunchFlags::lfStartMask ,
  lfWaitDefault = isys::IConnect::ELaunchFlags::lfWaitDefault , lfWait30ms = isys::IConnect::ELaunchFlags::lfWait30ms ,
  lfWait100ms = isys::IConnect::ELaunchFlags::lfWait100ms , lfWait300ms = isys::IConnect::ELaunchFlags::lfWait300ms ,
  lfWait1s = isys::IConnect::ELaunchFlags::lfWait1s , lfWait3s = isys::IConnect::ELaunchFlags::lfWait3s ,
  lfWait10s = isys::IConnect::ELaunchFlags::lfWait10s , lfWait30s = isys::IConnect::ELaunchFlags::lfWait30s ,
  lfWaitMask = isys::IConnect::ELaunchFlags::lfWaitMask , lfUseIPCDiscovery = isys::IConnect::ELaunchFlags::lfUseIPCDiscovery ,
  lfShowDefault = isys::IConnect::ELaunchFlags::lfShowDefault , lfShowMinimized = isys::IConnect::ELaunchFlags::lfShowMinimized ,
  lfShowMaximized = isys::IConnect::ELaunchFlags::lfShowMaximized , lfShowHidden = isys::IConnect::ELaunchFlags::lfShowHidden ,
  lfShowMask = isys::IConnect::ELaunchFlags::lfShowMask
}
 

Public Member Functions

virtual HRESULT Detach (DWORD dwDetachFlags=0) PURE
 Closes the interprocess channel to winIDEA. More...
 

Member Enumeration Documentation

◆ EDetachFlags

Deprecated:
For C++ use flags from isys::IConnect::EDetachFlags (i_ConnectTypes.h), for other languages the right type is automatically used. Provided for backwards compatibility.
Enumerator
dfCloseServerIfLastClient 

See isys::IConnect::EDetachFlags.

dfCloseServerUnconditional 

See isys::IConnect::EDetachFlags.

dfCloseServerMask 

See isys::IConnect::EDetachFlags.

dfCloseAutoSaveDefault 

See isys::IConnect::EDetachFlags.

dfCloseAutoSaveAll 

See isys::IConnect::EDetachFlags.

dfCloseAutoSaveNone 

See isys::IConnect::EDetachFlags.

dfCloseAutoSaveMask 

See isys::IConnect::EDetachFlags.

◆ ELaunchFlags

Deprecated:
Use flags from isys::IConnect::ELaunchFlags. For C++ add namespace prefix isys:: in the code, for other languages the flags moved to i_ConnectTypes.h are automatically used. This enum is provided for backwards compatibility only.
Enumerator
lfStartNever 

See isys::IConnect::ELaunchFlags.

lfStartIfRequired 

See isys::IConnect::ELaunchFlags.

lfStartAlways 

See isys::IConnect::ELaunchFlags.

lfStartExisting 

See isys::IConnect::ELaunchFlags.

lfStartEnumerate 

See isys::IConnect::ELaunchFlags.

lfStartMask 

See isys::IConnect::ELaunchFlags.

lfWaitDefault 

See isys::IConnect::ELaunchFlags.

lfWait30ms 

See isys::IConnect::ELaunchFlags.

lfWait100ms 

See isys::IConnect::ELaunchFlags.

lfWait300ms 

See isys::IConnect::ELaunchFlags.

lfWait1s 

See isys::IConnect::ELaunchFlags.

lfWait3s 

See isys::IConnect::ELaunchFlags.

lfWait10s 

See isys::IConnect::ELaunchFlags.

lfWait30s 

See isys::IConnect::ELaunchFlags.

lfWaitMask 

See isys::IConnect::ELaunchFlags.

lfUseIPCDiscovery 

See isys::IConnect::ELaunchFlags.

lfShowDefault 

See isys::IConnect::ELaunchFlags.

lfShowMinimized 

See isys::IConnect::ELaunchFlags.

lfShowMaximized 

See isys::IConnect::ELaunchFlags.

lfShowHidden 

See isys::IConnect::ELaunchFlags.

lfShowMask 

See isys::IConnect::ELaunchFlags.

Member Function Documentation

◆ Detach()

virtual HRESULT IConnect::Detach ( DWORD  dwDetachFlags = 0)
virtual

Closes the interprocess channel to winIDEA.

After that, all IConnectXX function calls other then IConnect::Attach will fail.

Parameters
dwDetachFlagsORed IConnect::EDetachFlags