# INexusCore interface

*No description yet.*

```csharp
public interface INexusCore
```

**Namespace:** SCH · **Assembly:** Altium.SDK.Interfaces

## Properties

| Property | Type | Access | Description |
| --- | --- | --- | --- |
| [EmbeddedProjectPath](#embeddedprojectpath) | `string` | get; set |  |

### EmbeddedProjectPath

*No description yet.*

```csharp
string GetEmbeddedProjectPath();
void SetEmbeddedProjectPath(string argProjectPath);
```

**Type:** `string` · **Access:** read/write

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [CrossProbe](#crossprobe) | `void` |  |
| [DownloadProgramMemory](#downloadprogrammemory) | `void` |  |
| [Export_CoreGenParameters](#export_coregenparameters) | `void` |  |
| [Export_CoreGenParametersToString](#export_coregenparameterstostring) | `string` |  |
| [Export_ToParameters](#export_toparameters) | `void` |  |
| [Export_ToParameterString](#export_toparameterstring) | `string` |  |
| [FindFileInProjectPaths](#findfileinprojectpaths) | `string` |  |
| [GetAspComponentDesignator](#getaspcomponentdesignator) | `string` |  |
| [GetBaseComponentDesignator](#getbasecomponentdesignator) | `string` |  |
| [GetChildCore](#getchildcore) | [INexusCore](#) |  |
| [GetChildCoreCount](#getchildcorecount) | `int` |  |
| [GetChildCoreDesignator](#getchildcoredesignator) | `string` |  |
| [GetChildProgramMemoryCore](#getchildprogrammemorycore) | [INexusCore](#) |  |
| [GetChildProgramMemoryCoreCount](#getchildprogrammemorycorecount) | `int` |  |
| [GetComponentDesignator](#getcomponentdesignator) | `string` |  |
| [GetComponentDocumentPath](#getcomponentdocumentpath) | `string` |  |
| [GetCoreKind](#getcorekind) | [TNexusCoreKind](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TNexusCoreKind.md) |  |
| [GetCrossViewProcessId](#getcrossviewprocessid) | `int` |  |
| [GetDescription](#getdescription) | `string` |  |
| [GetDeviceName](#getdevicename) | `string` |  |
| [GetEmbeddedProject](#getembeddedproject) | [IProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IProject.md) |  |
| [GetFPGAProject](#getfpgaproject) | [IProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IProject.md) |  |
| [GetFPGAProjectPath](#getfpgaprojectpath) | `string` |  |
| [GetHexFileEndianness](#gethexfileendianness) | `string` |  |
| [GetHexFilename](#gethexfilename) | `string` |  |
| [GetHexFilePath](#gethexfilepath) | `string` |  |
| [GetHexFileState](#gethexfilestate) | [TFlowState](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TFlowState.md) |  |
| [GetJTagIndex_FromCore](#getjtagindex_fromcore) | `int` |  |
| [GetLibraryReference](#getlibraryreference) | `string` |  |
| [GetNexusWorkbench](#getnexusworkbench) | [INexusWorkbench](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/INexusWorkbench.md) |  |
| [GetParameterValue](#getparametervalue) | `string` |  |
| [GetUniqueId](#getuniqueid) | `string` |  |
| [Import_FromParameters](#import_fromparameters) | `void` |  |
| [Import_FromParameterString](#import_fromparameterstring) | `void` |  |
| [MatchesOtherCore](#matchesothercore) | `bool` |  |
| [SetCrossViewProcessId](#setcrossviewprocessid) | `void` |  |
| [SupportsParameter](#supportsparameter) | `bool` |  |
| [UpdateHexFileState](#updatehexfilestate) | `void` |  |
| [VerifyProgramMemory](#verifyprogrammemory) | `void` |  |

### CrossProbe

*No description yet.*

```csharp
void CrossProbe();
```

**Returns:** nothing (`void`)

### DownloadProgramMemory

*No description yet.*

```csharp
void DownloadProgramMemory(INexusDevice argNexusDevice);
void DownloadProgramMemory(object argNexusDevice);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argNexusDevice` | [INexusDevice](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/INexusDevice.md) | value |

**Returns:** nothing (`void`)

The first overload is an extension method of `INexusCoreHelper` (`using SCH;`) with typed parameters; the second is declared by the interface.

### Export_CoreGenParameters

*No description yet.*

```csharp
void Export_CoreGenParameters(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### Export_CoreGenParametersToString

*No description yet.*

```csharp
string Export_CoreGenParametersToString();
```

**Returns:** `string`

### Export_ToParameters

*No description yet.*

```csharp
void Export_ToParameters(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### Export_ToParameterString

*No description yet.*

```csharp
string Export_ToParameterString();
```

**Returns:** `string`

### FindFileInProjectPaths

*No description yet.*

```csharp
string FindFileInProjectPaths(string argFileName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argFileName` | `string` | value |

**Returns:** `string`

### GetAspComponentDesignator

*No description yet.*

```csharp
string GetAspComponentDesignator();
```

**Returns:** `string`

### GetBaseComponentDesignator

*No description yet.*

```csharp
string GetBaseComponentDesignator();
```

**Returns:** `string`

### GetChildCore

*No description yet.*

```csharp
INexusCore GetChildCore(int argIndex);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argIndex` | `int` | value |

**Returns:** [INexusCore](#)

Extension method of `INexusCoreHelper` (`using SCH;`).

### GetChildCoreCount

*No description yet.*

```csharp
int GetChildCoreCount();
```

**Returns:** `int`

### GetChildCoreDesignator

*No description yet.*

```csharp
string GetChildCoreDesignator(int argIndex);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argIndex` | `int` | value |

**Returns:** `string`

### GetChildProgramMemoryCore

*No description yet.*

```csharp
INexusCore GetChildProgramMemoryCore(int argIndex);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argIndex` | `int` | value |

**Returns:** [INexusCore](#)

Extension method of `INexusCoreHelper` (`using SCH;`).

### GetChildProgramMemoryCoreCount

*No description yet.*

```csharp
int GetChildProgramMemoryCoreCount();
```

**Returns:** `int`

### GetComponentDesignator

*No description yet.*

```csharp
string GetComponentDesignator();
```

**Returns:** `string`

### GetComponentDocumentPath

*No description yet.*

```csharp
string GetComponentDocumentPath();
```

**Returns:** `string`

### GetCoreKind

*No description yet.*

```csharp
TNexusCoreKind GetCoreKind();
```

**Returns:** [TNexusCoreKind](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TNexusCoreKind.md)

Extension method of `INexusCoreHelper` (`using SCH;`).

### GetCrossViewProcessId

*No description yet.*

```csharp
int GetCrossViewProcessId();
```

**Returns:** `int`

### GetDescription

*No description yet.*

```csharp
string GetDescription();
```

**Returns:** `string`

### GetDeviceName

*No description yet.*

```csharp
string GetDeviceName();
```

**Returns:** `string`

### GetEmbeddedProject

*No description yet.*

```csharp
IProject GetEmbeddedProject();
```

**Returns:** [IProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IProject.md)

Extension method of `INexusCoreHelper` (`using SCH;`).

### GetFPGAProject

*No description yet.*

```csharp
IProject GetFPGAProject();
```

**Returns:** [IProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IProject.md)

Extension method of `INexusCoreHelper` (`using SCH;`).

### GetFPGAProjectPath

*No description yet.*

```csharp
string GetFPGAProjectPath();
```

**Returns:** `string`

### GetHexFileEndianness

*No description yet.*

```csharp
string GetHexFileEndianness();
```

**Returns:** `string`

### GetHexFilename

*No description yet.*

```csharp
string GetHexFilename();
```

**Returns:** `string`

### GetHexFilePath

*No description yet.*

```csharp
string GetHexFilePath();
```

**Returns:** `string`

### GetHexFileState

*No description yet.*

```csharp
TFlowState GetHexFileState();
```

**Returns:** [TFlowState](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TFlowState.md)

Extension method of `INexusCoreHelper` (`using SCH;`).

### GetJTagIndex_FromCore

*No description yet.*

```csharp
int GetJTagIndex_FromCore();
```

**Returns:** `int`

### GetLibraryReference

*No description yet.*

```csharp
string GetLibraryReference();
```

**Returns:** `string`

### GetNexusWorkbench

*No description yet.*

```csharp
INexusWorkbench GetNexusWorkbench();
```

**Returns:** [INexusWorkbench](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/INexusWorkbench.md)

Extension method of `INexusCoreHelper` (`using SCH;`).

### GetParameterValue

*No description yet.*

```csharp
string GetParameterValue(string argName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argName` | `string` | value |

**Returns:** `string`

### GetUniqueId

*No description yet.*

```csharp
string GetUniqueId();
```

**Returns:** `string`

### Import_FromParameters

*No description yet.*

```csharp
void Import_FromParameters(string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | value |

**Returns:** nothing (`void`)

### Import_FromParameterString

*No description yet.*

```csharp
void Import_FromParameterString(string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | value |

**Returns:** nothing (`void`)

### MatchesOtherCore

*No description yet.*

```csharp
bool MatchesOtherCore(INexusCore argCore);
bool MatchesOtherCore(object argCore);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argCore` | [INexusCore](#) | value |

**Returns:** `bool`

The first overload is an extension method of `INexusCoreHelper` (`using SCH;`) with typed parameters; the second is declared by the interface.

### SetCrossViewProcessId

*No description yet.*

```csharp
void SetCrossViewProcessId(UIntPtr argProcessID);
void SetCrossViewProcessId(object argProcessID);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argProcessID` | `UIntPtr` | value |

**Returns:** nothing (`void`)

The first overload is an extension method of `INexusCoreHelper` (`using SCH;`) with typed parameters; the second is declared by the interface.

### SupportsParameter

*No description yet.*

```csharp
bool SupportsParameter(string argName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argName` | `string` | value |

**Returns:** `bool`

### UpdateHexFileState

*No description yet.*

```csharp
void UpdateHexFileState();
```

**Returns:** nothing (`void`)

### VerifyProgramMemory

*No description yet.*

```csharp
void VerifyProgramMemory(INexusDevice argNexusDevice);
void VerifyProgramMemory(object argNexusDevice);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argNexusDevice` | [INexusDevice](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/INexusDevice.md) | value |

**Returns:** nothing (`void`)

The first overload is an extension method of `INexusCoreHelper` (`using SCH;`) with typed parameters; the second is declared by the interface.

## Returned by

[IDeviceLink.GetNexusCore](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IDeviceLink.md#getnexuscore), [INexusWorkbench.GetCoreFromDesignator](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/INexusWorkbench.md#getcorefromdesignator), [INexusWorkbench.GetCoreFromDevice](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/INexusWorkbench.md#getcorefromdevice), [IProjectLink.GetCoreFromDesignator](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IProjectLink.md#getcorefromdesignator), [IProjectLink.GetNexusCore_All](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IProjectLink.md#getnexuscore_all), [IProjectLink.GetNexusCore_Instrument](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IProjectLink.md#getnexuscore_instrument)