ILogReport interface
No description yet.
public interface ILogReport
Namespace: PCB · Assembly: Altium.SDK.Interfaces
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| Options | ILogReportOption | get | |
| ProjectName | string | get; set |
Options
No description yet.
ILogReportOption Get_Options();
Type: ILogReportOption · Access: read-only
The accessors are extension methods of ILogReportHelper (using PCB;).
ProjectName
No description yet.
string Get_ProjectName();
void Set_ProjectName(string argValue);
Type: string · Access: read/write
Methods
| Method | Returns | Description |
|---|---|---|
| AddMessage | void | |
| AddSection | ILogSection | |
| Clear | void | |
| GetReportStatus | void | |
| WriteToFile | bool |
AddMessage
No description yet.
void AddMessage(string argMessage);
| Parameter | Type | Passing |
|---|---|---|
argMessage | string | value |
Returns: nothing (void)
AddSection
No description yet.
ILogSection AddSection(string argSectionName);
| Parameter | Type | Passing |
|---|---|---|
argSectionName | string | value |
Returns: ILogSection
Extension method of ILogReportHelper (using PCB;).
Clear
No description yet.
void Clear();
Returns: nothing (void)
GetReportStatus
No description yet.
void GetReportStatus(ref int argErrorCount, ref int argWarningCount, ref int argEventCount);
| Parameter | Type | Passing |
|---|---|---|
argErrorCount | int | ref |
argWarningCount | int | ref |
argEventCount | int | ref |
Returns: nothing (void)
WriteToFile
No description yet.
bool WriteToFile(string argOutputFilePath);
| Parameter | Type | Passing |
|---|---|---|
argOutputFilePath | string | value |
Returns: bool