Book Creator
 Add this page to your book

Book Creator
 Remove this page from your book  

 Manage book (0 page(s))

 Help

~~NOTRANS~~ ====== PlcStatus Members ====== **Namespace:** IPS7Lnk.Advanced \\ **Assemblies:** IPS7LnkNet.Advanced.dll, IPS7LnkNet.Advanced.dll \\ The [[IPS7Lnk.Advanced.PlcStatus|PlcStatus]] type exposes the following members. ===== Constructors ===== ==== PlcStatus() ==== <panel> Initializes a new instance of the [[IPS7Lnk.Advanced.PlcStatus|PlcStatus]] class. **C#** \\ <code csharp> public PlcStatus() </code> </panel> ===== Events ===== ==== Changed ==== <panel> Occurs when the [[IPS7Lnk.Advanced.PlcStatus|PlcStatus]] changed. **C#** \\ <code csharp> public event EventHandler Changed </code> </panel> ===== Properties ===== ==== Code ==== <panel> Gets the recent code of the status represented. **C#** \\ <code csharp> public PlcStatusCode Code { get; } </code> \\ **Property Value** [[IPS7Lnk.Advanced.PlcStatusCode|PlcStatusCode]] \\ One of the members defined by the [[IPS7Lnk.Advanced.PlcStatusCode|PlcStatusCode]] enumeration. Which specifies the concrete type of status represented. </panel> ==== Exception ==== <panel> Gets the [[IPS7Lnk.Advanced.PlcException|PlcException]] which is thrown in case there the evaluation of the [[IPS7Lnk.Advanced.PlcStatus|PlcStatus]] does indicate an exceptional situation. **C#** \\ <code csharp> public PlcException Exception { get; } </code> \\ **Property Value** [[IPS7Lnk.Advanced.PlcException|PlcException]] \\ An instance of the [[IPS7Lnk.Advanced.PlcException|PlcException]] class initialized according to the current state of this [[IPS7Lnk.Advanced.PlcStatus|PlcStatus]]. </panel> ==== InnerException ==== <panel> Gets the [[IPS7Lnk.Advanced.PlcStatusMembers#Exception|Exception]] which occured during the most recent operation. **C#** \\ <code csharp> public Exception InnerException { get; } </code> \\ **Property Value** [[https://docs.microsoft.com/en-us/dotnet/api/system.exception|Exception]] \\ The [[IPS7Lnk.Advanced.PlcStatusMembers#Exception|Exception]] which occured during the most recent operation. </panel> ==== SocketCode ==== <panel> Gets the code of the recent socket operation performed its status is represented. **C#** \\ <code csharp> public int SocketCode { get; } </code> \\ **Property Value** [[https://docs.microsoft.com/en-us/dotnet/api/system.int32|Int32]] \\ The code of the recent socket operation performed its status is represented. </panel> ==== Text ==== <panel> Gets the string representation of the [[IPS7Lnk.Advanced.PlcStatusMembers#Code|Code]]. **C#** \\ <code csharp> public string Text { get; } </code> \\ **Property Value** [[https://docs.microsoft.com/en-us/dotnet/api/system.string|String]] \\ The string representation of the [[IPS7Lnk.Advanced.PlcStatusMembers#Code|Code]]. These [[https://docs.microsoft.com/en-us/dotnet/api/system.string|String]] value describes the status in a more meaningful way as the [[IPS7Lnk.Advanced.PlcStatusMembers#Code|Code]] does. </panel> ==== TimeStamp ==== <panel> Gets the date and time of the most recent update of the status data provided by this [[IPS7Lnk.Advanced.PlcStatus|PlcStatus]]. **C#** \\ <code csharp> public DateTime TimeStamp { get; } </code> \\ **Property Value** [[https://docs.microsoft.com/en-us/dotnet/api/system.datetime|DateTime]] \\ The [[https://docs.microsoft.com/en-us/dotnet/api/system.datetime|DateTime]] of the most recent metadata update. </panel> ==== Type ==== <panel> Gets the [[IPS7Lnk.Advanced.PlcType|PlcType]] affected by the most recent operation. **C#** \\ <code csharp> public PlcType Type { get; } </code> \\ **Property Value** [[IPS7Lnk.Advanced.PlcType|PlcType]] \\ The [[IPS7Lnk.Advanced.PlcType|PlcType]] affected by the most recent operation. </panel> ===== Methods ===== ==== GetText(PlcStatusCode) ==== <panel> Retrieves a meaningful string value which describes the status represented by the ''code''. **C#** \\ <code csharp> public static string GetText(PlcStatusCode code) </code> \\ **Parameters** ''code'' [[IPS7Lnk.Advanced.PlcStatusCode|PlcStatusCode]] \\ The [[IPS7Lnk.Advanced.PlcStatusCode|PlcStatusCode]] its textual description is to be retrieved.\\ \\ **Returns** [[https://docs.microsoft.com/en-us/dotnet/api/system.string|String]] \\ A meaningful string value which describes the ''code''. </panel> ==== GetText(PlcStatusCode, Int32) ==== <panel> Retrieves a meaningful string value which describes the status represented by the ''code'' and ''socketCode''. **C#** \\ <code csharp> public static string GetText(PlcStatusCode code, int socketCode) </code> \\ **Parameters** ''code'' [[IPS7Lnk.Advanced.PlcStatusCode|PlcStatusCode]] \\ The [[IPS7Lnk.Advanced.PlcStatusCode|PlcStatusCode]] its textual description is to be retrieved.\\ ''socketCode'' [[https://docs.microsoft.com/en-us/dotnet/api/system.int32|Int32]] \\ The code of the socket operation which ended with the ''code''.\\ \\ **Returns** [[https://docs.microsoft.com/en-us/dotnet/api/system.string|String]] \\ A meaningful string value which describes the ''code'' and ''socketCode''. </panel> ==== GetText(PlcStatusCode, Int32, PlcType) ==== <panel> Retrieves a meaningful string value which describes the status represented by the ''code'', ''socketCode'' and ''type''. **C#** \\ <code csharp> public static string GetText(PlcStatusCode code, int socketCode, PlcType type) </code> \\ **Parameters** ''code'' [[IPS7Lnk.Advanced.PlcStatusCode|PlcStatusCode]] \\ The [[IPS7Lnk.Advanced.PlcStatusCode|PlcStatusCode]] its textual description is to be retrieved.\\ ''socketCode'' [[https://docs.microsoft.com/en-us/dotnet/api/system.int32|Int32]] \\ The code of the socket operation which ended with the ''code''.\\ ''type'' [[IPS7Lnk.Advanced.PlcType|PlcType]] \\ The [[IPS7Lnk.Advanced.PlcType|PlcType]] which was affected by the operation its status text is to be retrieved.\\ \\ **Returns** [[https://docs.microsoft.com/en-us/dotnet/api/system.string|String]] \\ A meaningful string value which describes the ''code'' and ''socketCode''. </panel> ==== OnChanged(EventArgs) ==== <panel> Raises the [[IPS7Lnk.Advanced.PlcStatusMembers#Changed|Changed]] event. **C#** \\ <code csharp> protected virtual void OnChanged(EventArgs e) </code> \\ **Parameters** ''e'' [[https://docs.microsoft.com/en-us/dotnet/api/system.eventargs|EventArgs]] \\ The [[https://docs.microsoft.com/en-us/dotnet/api/system.eventargs|EventArgs]] that contains the event data.\\ </panel> ==== ToString() ==== <panel> Returns a string that represents the [[IPS7Lnk.Advanced.PlcStatus|PlcStatus]]. **C#** \\ <code csharp> public override string ToString() </code> \\ **Returns** [[https://docs.microsoft.com/en-us/dotnet/api/system.string|String]] \\ A string that represents the [[IPS7Lnk.Advanced.PlcStatus|PlcStatus]]. </panel>