IPCB_ParameterList interface

No description yet.

public interface IPCB_ParameterList

Namespace: PCB · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
ByIndex	IPCB_Parameter	get; set

ByIndex

No description yet.

IPCB_Parameter GetByIndex(int argIndex);
void SetByIndex(int argIndex, IPCB_Parameter argParameter);

Type: IPCB_Parameter · Access: read/write · Index: argIndex (int)

The accessors are extension methods of IPCB_ParameterListHelper (using PCB;).

Methods

Method	Returns	Description
Add	void
Clear	void
FindByName	IPCB_Parameter
GetByName	IPCB_Parameter
GetCount	int
RemoveByIndex	void
RemoveByName	void
TryRemoveByName	bool

Add

No description yet.

void Add(IPCB_Parameter argParameter);
void Add(object argParameter);

Parameter	Type	Passing
argParameter	IPCB_Parameter	value

Returns: nothing (void)

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

Clear

No description yet.

void Clear();

Returns: nothing (void)

FindByName

No description yet.

IPCB_Parameter FindByName(string argName);

Parameter	Type	Passing
argName	string	value

Returns: IPCB_Parameter

Extension method of IPCB_ParameterListHelper (using PCB;).

GetByName

No description yet.

IPCB_Parameter GetByName(string argName);

Parameter	Type	Passing
argName	string	value

Returns: IPCB_Parameter

Extension method of IPCB_ParameterListHelper (using PCB;).

GetCount

No description yet.

int GetCount();

Returns: int

RemoveByIndex

No description yet.

void RemoveByIndex(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: nothing (void)

RemoveByName

No description yet.

void RemoveByName(string argName);

Parameter	Type	Passing
argName	string	value

Returns: nothing (void)

TryRemoveByName

No description yet.

bool TryRemoveByName(string argName);

Parameter	Type	Passing
argName	string	value

Returns: bool

Returned by

IPCB_EmbeddedBoard.GetForbiddenParameterList, IPCB_FullComponent.GetParameters, IPCB_FullComponent.GetSystemParameters, IPCB_ParametersFactory.CreateParameterList, IPCB_PrimitiveParameters.ExportToList

Accepted by

IPCB_PrimitiveParameters.ImportFromList, IPCB_SpecialStringConverter.AddForbiddenParamList