# IEmbeddedStackSync interface

*No description yet.*

```csharp
public interface IEmbeddedStackSync
```

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

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [BeginSync](#beginsync) | `void` |  |
| [CheckIsSupported](#checkissupported) | `bool` |  |
| [EndSync](#endsync) | `void` |  |
| [FpgaComponentSetOptionValue](#fpgacomponentsetoptionvalue) | `bool` |  |
| [FpgaComponentSetParameters](#fpgacomponentsetparameters) | `bool` |  |
| [FpgaComponentSync](#fpgacomponentsync) | `bool` |  |
| [FpgaSetInterruptMask](#fpgasetinterruptmask) | `bool` |  |
| [GetPlugin](#getplugin) | `string` |  |
| [GetPluginCount](#getplugincount) | `int` |  |
| [GetPluginFromHardwareId](#getpluginfromhardwareid) | `string` |  |
| [GetSwPlatformClockSpeed](#getswplatformclockspeed) | `string` |  |
| [PluginGetCaption](#plugingetcaption) | `string` |  |
| [PluginGetDebugXmlFile](#plugingetdebugxmlfile) | `string` |  |
| [PluginGetDescription](#plugingetdescription) | `string` |  |
| [PluginGetHelpFile](#plugingethelpfile) | `string` |  |
| [PluginGetInstanceCount](#plugingetinstancecount) | `int` |  |
| [PluginGetOptionValue](#plugingetoptionvalue) | `string` |  |
| [PluginGetPinCaptions](#plugingetpincaptions) | `string` |  |
| [PluginGetPinMappingCaptions](#plugingetpinmappingcaptions) | `string` |  |
| [PluginGetPinMappingOptionName](#plugingetpinmappingoptionname) | `string` |  |
| [PluginGetPinMappingValues](#plugingetpinmappingvalues) | `string` |  |
| [PluginGetPinValues](#plugingetpinvalues) | `string` |  |
| [PluginHasInstance](#pluginhasinstance) | `bool` |  |
| [PluginInstanceGetHardwareId](#plugininstancegethardwareid) | `string` |  |
| [PluginInstanceGetId](#plugininstancegetid) | `string` |  |
| [PluginInstanceGetLinksUpCount](#plugininstancegetlinksupcount) | `int` |  |
| [PluginInstanceGetLinkUpInstanceId](#plugininstancegetlinkupinstanceid) | `string` |  |
| [PluginInstanceGetName](#plugininstancegetname) | `string` |  |
| [PluginInstanceGetOptionValue](#plugininstancegetoptionvalue) | `string` |  |
| [PluginInstanceGetPlugin](#plugininstancegetplugin) | `string` |  |
| [PluginInstanceSetName](#plugininstancesetname) | `bool` |  |
| [PluginInstanceSetOptionValue](#plugininstancesetoptionvalue) | `bool` |  |
| [PluginIsPeripheral](#pluginisperipheral) | `bool` |  |
| [PluginSetOptionValue](#pluginsetoptionvalue) | `bool` |  |

### BeginSync

*No description yet.*

```csharp
void BeginSync();
```

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

### CheckIsSupported

*No description yet.*

```csharp
bool CheckIsSupported(string argHardwareId);
```

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

**Returns:** `bool`

### EndSync

*No description yet.*

```csharp
void EndSync();
```

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

### FpgaComponentSetOptionValue

*No description yet.*

```csharp
bool FpgaComponentSetOptionValue(string argComponentId, string argnOptionName, string argValue);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argComponentId` | `string` | value |
| `argnOptionName` | `string` | value |
| `argValue` | `string` | value |

**Returns:** `bool`

### FpgaComponentSetParameters

*No description yet.*

```csharp
bool FpgaComponentSetParameters(string argComponentId, string argParamString);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argComponentId` | `string` | value |
| `argParamString` | `string` | value |

**Returns:** `bool`

### FpgaComponentSync

*No description yet.*

```csharp
bool FpgaComponentSync(string argComponentId, string argName, string argHardwareId);
```

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

**Returns:** `bool`

### FpgaSetInterruptMask

*No description yet.*

```csharp
bool FpgaSetInterruptMask(int argMask);
```

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

**Returns:** `bool`

### GetPlugin

*No description yet.*

```csharp
string GetPlugin(int argnIndex);
```

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

**Returns:** `string`

### GetPluginCount

*No description yet.*

```csharp
int GetPluginCount();
```

**Returns:** `int`

### GetPluginFromHardwareId

*No description yet.*

```csharp
string GetPluginFromHardwareId(string argHardwareId);
```

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

**Returns:** `string`

### GetSwPlatformClockSpeed

*No description yet.*

```csharp
string GetSwPlatformClockSpeed();
```

**Returns:** `string`

### PluginGetCaption

*No description yet.*

```csharp
string PluginGetCaption(string argPluginName);
```

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

**Returns:** `string`

### PluginGetDebugXmlFile

*No description yet.*

```csharp
string PluginGetDebugXmlFile(string argPluginName);
```

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

**Returns:** `string`

### PluginGetDescription

*No description yet.*

```csharp
string PluginGetDescription(string argPluginName);
```

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

**Returns:** `string`

### PluginGetHelpFile

*No description yet.*

```csharp
string PluginGetHelpFile(string argPluginName);
```

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

**Returns:** `string`

### PluginGetInstanceCount

*No description yet.*

```csharp
int PluginGetInstanceCount(string argPluginName);
```

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

**Returns:** `int`

### PluginGetOptionValue

*No description yet.*

```csharp
string PluginGetOptionValue(string argPluginName, string argnOptionName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argPluginName` | `string` | value |
| `argnOptionName` | `string` | value |

**Returns:** `string`

### PluginGetPinCaptions

*No description yet.*

```csharp
string PluginGetPinCaptions(string argPluginName, string argInstanceId, string argPinName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argPluginName` | `string` | value |
| `argInstanceId` | `string` | value |
| `argPinName` | `string` | value |

**Returns:** `string`

### PluginGetPinMappingCaptions

*No description yet.*

```csharp
string PluginGetPinMappingCaptions(string argPluginName, string argInstanceId);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argPluginName` | `string` | value |
| `argInstanceId` | `string` | value |

**Returns:** `string`

### PluginGetPinMappingOptionName

*No description yet.*

```csharp
string PluginGetPinMappingOptionName(string argPluginName);
```

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

**Returns:** `string`

### PluginGetPinMappingValues

*No description yet.*

```csharp
string PluginGetPinMappingValues(string argPluginName, string argInstanceId);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argPluginName` | `string` | value |
| `argInstanceId` | `string` | value |

**Returns:** `string`

### PluginGetPinValues

*No description yet.*

```csharp
string PluginGetPinValues(string argPluginName, string argInstanceId, string argPinName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argPluginName` | `string` | value |
| `argInstanceId` | `string` | value |
| `argPinName` | `string` | value |

**Returns:** `string`

### PluginHasInstance

*No description yet.*

```csharp
bool PluginHasInstance(string argPluginName, string argInstanceId);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argPluginName` | `string` | value |
| `argInstanceId` | `string` | value |

**Returns:** `bool`

### PluginInstanceGetHardwareId

*No description yet.*

```csharp
string PluginInstanceGetHardwareId(string argnInstanceId);
```

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

**Returns:** `string`

### PluginInstanceGetId

*No description yet.*

```csharp
string PluginInstanceGetId(string argPluginName, int argnInstanceIndex);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argPluginName` | `string` | value |
| `argnInstanceIndex` | `int` | value |

**Returns:** `string`

### PluginInstanceGetLinksUpCount

*No description yet.*

```csharp
int PluginInstanceGetLinksUpCount(string argnInstanceId);
```

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

**Returns:** `int`

### PluginInstanceGetLinkUpInstanceId

*No description yet.*

```csharp
string PluginInstanceGetLinkUpInstanceId(string argnInstanceId, int argnIndex);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argnInstanceId` | `string` | value |
| `argnIndex` | `int` | value |

**Returns:** `string`

### PluginInstanceGetName

*No description yet.*

```csharp
string PluginInstanceGetName(string argnInstanceId);
```

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

**Returns:** `string`

### PluginInstanceGetOptionValue

*No description yet.*

```csharp
string PluginInstanceGetOptionValue(string argnInstanceId, string argnOptionName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argnInstanceId` | `string` | value |
| `argnOptionName` | `string` | value |

**Returns:** `string`

### PluginInstanceGetPlugin

*No description yet.*

```csharp
string PluginInstanceGetPlugin(string argnInstanceId);
```

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

**Returns:** `string`

### PluginInstanceSetName

*No description yet.*

```csharp
bool PluginInstanceSetName(string argnInstanceId, string argName);
```

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

**Returns:** `bool`

### PluginInstanceSetOptionValue

*No description yet.*

```csharp
bool PluginInstanceSetOptionValue(string argnInstanceId, string argnOptionName, string argValue);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argnInstanceId` | `string` | value |
| `argnOptionName` | `string` | value |
| `argValue` | `string` | value |

**Returns:** `bool`

### PluginIsPeripheral

*No description yet.*

```csharp
bool PluginIsPeripheral(string argPluginName);
```

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

**Returns:** `bool`

### PluginSetOptionValue

*No description yet.*

```csharp
bool PluginSetOptionValue(string argPluginName, string argnOptionName, string argValue);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argPluginName` | `string` | value |
| `argnOptionName` | `string` | value |
| `argValue` | `string` | value |

**Returns:** `bool`

## Returned by

[IEmbeddedStack.GetEmbeddedStackSyncInterface](https://altiumdeveloper.github.io/ad-sdk-docs/reference/embedded/IEmbeddedStack.md#getembeddedstacksyncinterface)