Skip to content

ISIAPI Interface

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: 9C0B1932-3E16-4F86-9365-2E5F752328FC

SIDRA INTERSECTION API wrapper interface.

Declaration

[Guid("9C0B1932-3E16-4F86-9365-2E5F752328FC")]
public interface ISIAPI

Get an instance

var api = (ISIAPI)Activator.CreateInstance(
    Type.GetTypeFromProgID("SIDRASolutions.SI.API"));

Dim api As ISIAPI = CType(Activator.CreateInstance(
    Type.GetTypeFromProgID("SIDRASolutions.SI.API")), ISIAPI)

import win32com.client
api = win32com.client.Dispatch("SIDRASolutions.SI.API")

$api = New-Object -ComObject "SIDRASolutions.SI.API"

Properties

Project

Current open SIDRA INTERSECTION project.

ISIAPIProject Project { get; }

Type ISIAPIProject

Value

If no project is open NULL is returned.

Code samples 
var project = api.Project;

Dim project As ISIAPIProject = api.Project

project = api.Project

$project = $api.Project

IsLicensed

Indicates whether the installed version of SIDRA INTERSECTION is licensed.

bool IsLicensed { get; }

Type bool

Value

True if licensed. False if unlicensed or in Trial Mode.

Code samples 
bool isLicensed = api.IsLicensed;

Dim isLicensed As Boolean = api.IsLicensed

is_licensed = api.IsLicensed

$isLicensed = $api.IsLicensed

LastErrorMessage

string LastErrorMessage { get; }

Type string

Code samples 
string lastErrorMessage = api.LastErrorMessage;

Dim lastErrorMessage As String = api.LastErrorMessage

last_error_message = api.LastErrorMessage

$lastErrorMessage = $api.LastErrorMessage

IntPtrSize

int IntPtrSize { get; }

Type int

Code samples 
int intPtrSize = api.IntPtrSize;

Dim intPtrSize As Integer = api.IntPtrSize

int_ptr_size = api.IntPtrSize

$intPtrSize = $api.IntPtrSize

Methods

OpenProject(string)

Opens a SIDRA INTERSECTION Project.

bool OpenProject(string filename)

Parameters

Name Type Description
filename string Path of the SIDRA INTERSECTION Project file to open

Returns bool

Code samples 
bool result = api.OpenProject(@"C:\path\to\project.sip");

Dim result As Boolean = api.OpenProject("C:\path\to\project.sip")

result = api.OpenProject(r"C:\path\to\project.sip")

$result = $api.OpenProject("C:\path\to\project.sip")

CloseProject()

Closes the SIDRA INTERSECTION Project and save it.

bool CloseProject()

Returns bool

Code samples 
bool result = api.CloseProject();

Dim result As Boolean = api.CloseProject()

result = api.CloseProject()

$result = $api.CloseProject()

Close()

bool Close()

Returns bool

Code samples 
bool result = api.Close();

Dim result As Boolean = api.Close()

result = api.Close()

$result = $api.Close()

CreateAndOpenProject(string, string)

Creates and opens a SIDRA INTERSECTION Project.

bool CreateAndOpenProject(string filename, string newProjectName)

Parameters

Name Type Description
filename string Path of the SIDRA INTERSECTION Project file to open
newProjectName string The Project name

Returns bool

Code samples 
bool result = api.CreateAndOpenProject(@"C:\path\to\project.sip", @"Demo Project");

Dim result As Boolean = api.CreateAndOpenProject("C:\path\to\project.sip", "Demo Project")

result = api.CreateAndOpenProject(r"C:\path\to\project.sip", r"Demo Project")

$result = $api.CreateAndOpenProject("C:\path\to\project.sip", "Demo Project")

SaveProject()

Save the SIDRA INTERSECTION Project.

bool SaveProject()

Returns bool

Code samples 
bool result = api.SaveProject();

Dim result As Boolean = api.SaveProject()

result = api.SaveProject()

$result = $api.SaveProject()

CloseProjectWithoutSaving()

Close the SIDRA INTERSECTION Project without saving it.

bool CloseProjectWithoutSaving()

Returns bool

Code samples 
bool result = api.CloseProjectWithoutSaving();

Dim result As Boolean = api.CloseProjectWithoutSaving()

result = api.CloseProjectWithoutSaving()

$result = $api.CloseProjectWithoutSaving()