winIDEA SDK
Loading...
Searching...
No Matches
IConnectProject Struct Reference
Base

The IConnectProject interface provides access to build manager functions exported by winIDEA. More...

#include <i_Connect.h>

Classes

struct  SInfo
 Contains information about the build manager capabilities. More...
struct  SStatus
 Contains information about the build manager status. More...

Public Types

enum  EOperationFlags {
  ofCustom = 0x00000001 , ofCompile = 0x00000002 ,
  ofLink = 0x00000003 , ofMake = 0x00000004 ,
  ofBuild = 0x00000005 , ofDependencies = 0x00000006 ,
  ofIsUpToDate = 0x00000007 , ofSetTarget = 0x00000008 ,
  ofExport = 0x00000009 , ofImport = 0x0000000A ,
  ofStop = 0x0000000F , ofOperationMask = 0x0000000F ,
  ofSuppressPostLinkActions = 0x00000010
}
 Flags defining build manager operations. More...
enum  EOptionFlags {
  ofaGet = isys::IConnectProject::EOptionFlags::ofaGet , ofaEnum = isys::IConnectProject::EOptionFlags::ofaEnum ,
  ofaSet = isys::IConnectProject::EOptionFlags::ofaSet , ofaAdd = isys::IConnectProject::EOptionFlags::ofaAdd ,
  ofaRmv = isys::IConnectProject::EOptionFlags::ofaRmv , ofaMov = isys::IConnectProject::EOptionFlags::ofaMov ,
  ofaMask = isys::IConnectProject::EOptionFlags::ofaMask , ofaRelativePaths = isys::IConnectProject::EOptionFlags::ofaRelativePaths ,
  ofaEnumIndexMask = isys::IConnectProject::EOptionFlags::ofaEnumIndexMask
}

Public Member Functions

virtual HRESULT Operation (DWORD dwOperationFlags, const char *pszOperation, const char *pszParameters) PURE
 Invokes a build manager operation.
virtual HRESULT Option (DWORD dwOptionFlags, const char *pszScope, const char *pszOption, LPSTR pszValue, DWORD dwValueLen) PURE
 Sets or retrieves a build manager configuration option.

Detailed Description

The IConnectProject interface provides access to build manager functions exported by winIDEA.

Member Enumeration Documentation

◆ EOperationFlags

enum IConnectProject::EOperationFlags

Flags defining build manager operations.

Enumerator
ofCustom 

run custom operation specified by pszOperation

ofCompile 

compile the file specified by pszParameters (the file must be included in the active project)

ofLink 

link the active project

ofMake 

make the active project

ofBuild 

build the active project

ofDependencies 

update dependencies

ofIsUpToDate 

returns S_OK if up to date, or S_FALSE otherwise

ofSetTarget 

Set target to pszParameters.

ofExport 

Export project configuration to file given in pszParameters.

ofImport 

Import project configuration from file given in pszParameters.

ofStop 

stop the current operation

ofOperationMask 

mask for ofXXX values

ofSuppressPostLinkActions 

do not perform any automatic post-link actions

◆ EOptionFlags

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

See isys::IConnectProject::EOptionFlags.

ofaEnum 

See isys::IConnectProject::EOptionFlags.

ofaSet 

See isys::IConnectProject::EOptionFlags.

ofaAdd 

See isys::IConnectProject::EOptionFlags.

ofaRmv 

See isys::IConnectProject::EOptionFlags.

ofaMov 

See isys::IConnectProject::EOptionFlags.

ofaMask 

See isys::IConnectProject::EOptionFlags.

ofaRelativePaths 

See isys::IConnectProject::EOptionFlags.

ofaEnumIndexMask 

See isys::IConnectProject::EOptionFlags.

Member Function Documentation

◆ Operation()

virtual HRESULT IConnectProject::Operation ( DWORD dwOperationFlags,
const char * pszOperation,
const char * pszParameters )
virtual

Invokes a build manager operation.

Parameters
dwOperationFlagsspecifies the operation to execute. See IConnectProject::EOperationFlags
pszOperationIdentifies the custom operation to perform. The specified operation must be defined as custom operation in winIDEA. This parameter is ignored if ofCustom flag is not set.
pszParametersspecifies the additional parameters for the requested operation.
Returns
  • ICONNECT_E_NOT_AVAILABLE - the requested operation is not available
  • ICONNECT_E_FILE_NOT_FOUND - the specified file is not a part of the active project
  • E_NOTIMPL - the requested operation is not implemented

◆ Option()

virtual HRESULT IConnectProject::Option ( DWORD dwOptionFlags,
const char * pszScope,
const char * pszOption,
LPSTR pszValue,
DWORD dwValueLen )
virtual

Sets or retrieves a build manager configuration option.

For description of parameters, see CProjectController.