IFlashWriter interface

No description yet.

public interface IFlashWriter : IRemoteExecuteBaseDriver

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Inherits: IRemoteExecuteBaseDriver

Methods

Method	Returns	Description
AbortCurrentProcess	int
AddFlashMemorySpace	int
BeginTransaction	int
BlankCheckSectors	int
ClearAllFlashMemorySpaces	void
CompareWithFlash	int
EndTransation	int
EraseAddressRange	int
EraseFlash	int
EraseSectorRange	int
GetDefaultFlashWidth	int
GetFlashAddressFromSector	uint
GetFlashMemorySpaceCount	int
GetFlashMemorySpaceDescriptor	void
GetFlashSectorFromAddress	uint
GetSupportedDevicesList	IStrings
IsFlashMemorySpace	bool
IsFlashWidthSupported	bool
SetCallbackInterface	int
SupportsAction	bool
WriteFlash	int

AbortCurrentProcess

No description yet.

int AbortCurrentProcess();

Returns: int

AddFlashMemorySpace

No description yet.

int AddFlashMemorySpace(uint argGlobalMemorySpaceIndex, uint argStartAddress, uint argEndAddress, uint argWidthInBits);

Parameter	Type	Passing
argGlobalMemorySpaceIndex	uint	value
argStartAddress	uint	value
argEndAddress	uint	value
argWidthInBits	uint	value

Returns: int

BeginTransaction

No description yet.

int BeginTransaction();

Returns: int

BlankCheckSectors

No description yet.

int BlankCheckSectors(uint argFlashMemorySpaceIndex, uint argStartSector, uint argEndSector);

Parameter	Type	Passing
argFlashMemorySpaceIndex	uint	value
argStartSector	uint	value
argEndSector	uint	value

Returns: int

ClearAllFlashMemorySpaces

No description yet.

void ClearAllFlashMemorySpaces();

Returns: nothing (void)

CompareWithFlash

No description yet.

int CompareWithFlash(uint argFlashMemorySpaceIndex, IDataChunkImageInterface argDataImageInterface, uint argFlashAddress, uint argCompareByteCount, bool argEnableFilterFunction);
int CompareWithFlash(uint argFlashMemorySpaceIndex, object argDataImageInterface, uint argFlashAddress, uint argCompareByteCount, bool argEnableFilterFunction);

Parameter	Type	Passing
argFlashMemorySpaceIndex	uint	value
argDataImageInterface	IDataChunkImageInterface	value
argFlashAddress	uint	value
argCompareByteCount	uint	value
argEnableFilterFunction	bool	value

Returns: int

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

EndTransation

No description yet.

int EndTransation();

Returns: int

EraseAddressRange

No description yet.

int EraseAddressRange(uint argFlashMemorySpaceIndex, uint argStartAddress, uint argEndAddress, bool argPreserveUnwrittenData);

Parameter	Type	Passing
argFlashMemorySpaceIndex	uint	value
argStartAddress	uint	value
argEndAddress	uint	value
argPreserveUnwrittenData	bool	value

Returns: int

EraseFlash

No description yet.

int EraseFlash(uint argFlashMemorySpaceIndex);

Parameter	Type	Passing
argFlashMemorySpaceIndex	uint	value

Returns: int

EraseSectorRange

No description yet.

int EraseSectorRange(uint argFlashMemorySpaceIndex, uint argStartSector, uint argEndSector);

Parameter	Type	Passing
argFlashMemorySpaceIndex	uint	value
argStartSector	uint	value
argEndSector	uint	value

Returns: int

GetDefaultFlashWidth

No description yet.

int GetDefaultFlashWidth();

Returns: int

GetFlashAddressFromSector

No description yet.

uint GetFlashAddressFromSector(uint argFlashMemorySpaceIndex, uint argSectorNumber);

Parameter	Type	Passing
argFlashMemorySpaceIndex	uint	value
argSectorNumber	uint	value

Returns: uint

GetFlashMemorySpaceCount

No description yet.

int GetFlashMemorySpaceCount();

Returns: int

GetFlashMemorySpaceDescriptor

No description yet.

void GetFlashMemorySpaceDescriptor(uint argFlashMemorySpaceIndex, out uint argglobalMemorySpaceIndex, out uint argstartAddress, out uint argendAddress, out uint argwidthInBits);

Parameter	Type	Passing
argFlashMemorySpaceIndex	uint	value
argglobalMemorySpaceIndex	uint	out
argstartAddress	uint	out
argendAddress	uint	out
argwidthInBits	uint	out

Returns: nothing (void)

GetFlashSectorFromAddress

No description yet.

uint GetFlashSectorFromAddress(uint argFlashMemorySpaceIndex, uint argFlashAddress);

Parameter	Type	Passing
argFlashMemorySpaceIndex	uint	value
argFlashAddress	uint	value

Returns: uint

GetSupportedDevicesList

No description yet.

IStrings GetSupportedDevicesList();

Returns: IStrings

Extension method of IFlashWriterHelper (using SCH;).

IsFlashMemorySpace

No description yet.

bool IsFlashMemorySpace(uint argMemorySpaceIndex, uint argWriteAddress);

Parameter	Type	Passing
argMemorySpaceIndex	uint	value
argWriteAddress	uint	value

Returns: bool

IsFlashWidthSupported

No description yet.

bool IsFlashWidthSupported(int argFlashWidth);

Parameter	Type	Passing
argFlashWidth	int	value

Returns: bool

SetCallbackInterface

No description yet.

int SetCallbackInterface(IFlashWriterCallback argCallBackInterface);
int SetCallbackInterface(object argCallBackInterface);

Parameter	Type	Passing
argCallBackInterface	IFlashWriterCallback	value

Returns: int

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

SupportsAction

No description yet.

bool SupportsAction(uint argnAction);

Parameter	Type	Passing
argnAction	uint	value

Returns: bool

WriteFlash

No description yet.

int WriteFlash(uint argFlashMemorySpaceIndex, IDataChunkImageInterface argDataImageInterface, bool argEnableFilterFunction, bool argPreserveUnwrittenData, bool argResetDevice, bool argVerifyWrite);
int WriteFlash(uint argFlashMemorySpaceIndex, object argDataImageInterface, bool argEnableFilterFunction, bool argPreserveUnwrittenData, bool argResetDevice, bool argVerifyWrite);

Parameter	Type	Passing
argFlashMemorySpaceIndex	uint	value
argDataImageInterface	IDataChunkImageInterface	value
argEnableFilterFunction	bool	value
argPreserveUnwrittenData	bool	value
argResetDevice	bool	value
argVerifyWrite	bool	value

Returns: int

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

Inherited members

• From IRemoteExecuteBaseDriver: GetInternalAbort, GetInternalIsDriverInstalled, GetInternalIsDriverLoaded, GetInternalIsEnabled, GetInternalIsInitialized, GetInternalPreserveState, RemoteDriverBaseAddress, RemoteDriverDataBaseAddress, RemoteDriverDeviceName, RemoteDriverDeviceTitle, RemoteDriverFileName, RemoteDriverMainEntryPoint, RemoteDriverParamBaseAddress, RemoteDriverVendorName

Returned by

IFlashWriters.GetFlashWriter, IFlashWriters.GetSelectedFlashWriter

Accepted by

IFlashWriters.AddFlashWriter, IFlashWriters.SelectFlashWriter