SIDRA API¶

Type 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

Members¶

Properties

Property	Type	Summary
Project	`ISIAPIProject`	Current open SIDRA INTERSECTION project.
IsLicensed	`bool`	Indicates whether the installed version of SIDRA INTERSECTION is licensed.
LastErrorMessage	`string`
IntPtrSize	`int`
SourceAppName	`string`	The name of the application that calls SIAPI. It will be saved in Site, Network, Site Volume Bin and Assign Volume Bin's Created_by_source_app and Modified_by_source_app.

Methods

Method	Returns	Summary
OpenProject(string)	`bool`	Opens a SIDRA INTERSECTION Project.
CloseProject()	`bool`	Closes the SIDRA INTERSECTION Project and saves it.
Close()	`bool`	Closes API: saves and closes the project if it is still open, releases the licence and frees resources.
CreateAndOpenProject(string, string)	`bool`	Creates and opens a SIDRA INTERSECTION Project.
SaveProject()	`bool`	Save the SIDRA INTERSECTION Project.
CloseProjectWithoutSaving()	`bool`	Close the SIDRA INTERSECTION Project without saving it.

Get an instance¶

C#C++Python

// Add a reference to the SIDRA late-binding assembly (LB_SI<version>API.dll).
using SIDRASolutions.SI.API;

var api = new SIAPI();

// Import the SI API v11 type library by using its GUID. Change the GUID for other versions.
// #import "libid:a640d48f-577d-40a7-b91a-14c06a14f03b" raw_interfaces_only
// using namespace SIDRASolutions_SI_API;

CoInitialize(NULL);

CComPtr<ISIAPI> api;
api.CoCreateInstance(__uuidof(SIAPI));

import os
import winreg
from pythonnet import set_runtime
from clr_loader import get_coreclr

def sidra_install_path():
    """Read the SIDRA Intersection install folder from the registry."""
    key = r"SOFTWARE\SIDRA SOLUTIONS\SIDRA INTERSECTION 11"
    with winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, key) as k:
        return winreg.QueryValueEx(k, "InstallLocation")[0]

sidra = sidra_install_path()

# Host the API's own .NET 8 runtime (via its runtimeconfig), then load the DLL.
# This must happen before the first `import clr`.
set_runtime(get_coreclr(
    runtime_config=os.path.join(sidra, "SIDRASolutions.SI.API.runtimeconfig.json")))

import clr
clr.AddReference(os.path.join(sidra, "SIDRASolutions.SI.API.dll"))

from SIDRASolutions.SI.API import SIAPI

api = SIAPI()

Properties¶

Project¶

Current open SIDRA INTERSECTION project.

ISIAPIProject Project { get; }

Type ISIAPIProject

Value

If no project is open NULL is returned.

Code samples

C#C++Python

var project = api.Project;

CComPtr<ISIAPIProject> project;
api->get_Project(&project);

project = api.Project

IsLicensed¶

Indicates whether the installed version of SIDRA INTERSECTION is licensed.

bool IsLicensed { get; }

Type bool

Code samples

C#C++Python

bool isLicensed = api.IsLicensed;

VARIANT_BOOL isLicensed;
api->get_IsLicensed(&isLicensed);

is_licensed = api.IsLicensed

LastErrorMessage¶

string LastErrorMessage { get; }

Type string

Code samples

C#C++Python

string lastErrorMessage = api.LastErrorMessage;

CComBSTR lastErrorMessage;
api->get_LastErrorMessage(&lastErrorMessage);

last_error_message = api.LastErrorMessage

IntPtrSize¶

int IntPtrSize { get; }

Type int

Code samples

C#C++Python

int intPtrSize = api.IntPtrSize;

long intPtrSize;
api->get_IntPtrSize(&intPtrSize);

int_ptr_size = api.IntPtrSize

SourceAppName¶

The name of the application that calls SIAPI. It will be saved in Site, Network, Site Volume Bin and Assign Volume Bin's Created_by_source_app and Modified_by_source_app.

string SourceAppName { get; set; }

Type string

Code samples

C#C++Python

string sourceAppName = api.SourceAppName;
api.SourceAppName = @"Example";

CComBSTR sourceAppName;
api->get_SourceAppName(&sourceAppName);
api->put_SourceAppName(CComBSTR(L"Example"));

source_app_name = api.SourceAppName
api.SourceAppName = r"Example"

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

C#C++Python

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

VARIANT_BOOL result;
api->OpenProject(CComBSTR(L"C:\\path\\to\\project.sipx"), &result);

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

CloseProject()¶

Closes the SIDRA INTERSECTION Project and saves it.

bool CloseProject()

Returns bool

Code samples

C#C++Python

bool result = api.CloseProject();

VARIANT_BOOL result;
api->CloseProject(&result);

result = api.CloseProject()

Close()¶

Closes API: saves and closes the project if it is still open, releases the licence and frees resources.

bool Close()

Returns bool

Code samples

C#C++Python

bool result = api.Close();

VARIANT_BOOL result;
api->Close(&result);

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

C#C++Python

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

VARIANT_BOOL result;
api->CreateAndOpenProject(CComBSTR(L"C:\\path\\to\\project.sipx"), CComBSTR(L"Demo Project"), &result);

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

SaveProject()¶

Save the SIDRA INTERSECTION Project.

bool SaveProject()

Returns bool

Code samples

C#C++Python

bool result = api.SaveProject();

VARIANT_BOOL result;
api->SaveProject(&result);

result = api.SaveProject()

CloseProjectWithoutSaving()¶

Close the SIDRA INTERSECTION Project without saving it.

bool CloseProjectWithoutSaving()

Returns bool

Code samples

C#C++Python

bool result = api.CloseProjectWithoutSaving();

VARIANT_BOOL result;
api->CloseProjectWithoutSaving(&result);

result = api.CloseProjectWithoutSaving()