849 lines
44 KiB
XML
849 lines
44 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>NA2WNFC</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="M:NA2WNFC.NativeMethods.SCardEstablishContext(System.Int32,System.Int32,System.Int32,System.Int32@)">
|
|
The SCardEstablishContext function instantiates a context for the application
|
|
within the PC/SC Resource Manager. This must be the first function called in a
|
|
PC/SC application.
|
|
|
|
Parameters: dwScope - Scope of communication context. Can be either SCARD_SCOPE_USER
|
|
or SCARD_SCOPE_SYSTEM.
|
|
pvReserved1(in) - System Reserved and Must be NULL.
|
|
pvReserved2(in) - System Reserved and Must be NULL.
|
|
PhContext(out) - Handle to the PC/SC resource manager(established communication context).
|
|
</member>
|
|
<member name="M:NA2WNFC.NativeMethods.SCardReleaseContext(System.Int32)">
|
|
The SCardReleaseContext function destroys the application context within the
|
|
PC/SC Resource Manager. This must be the last function called in a PC/SC
|
|
application.
|
|
|
|
Parameters: hContext(in) - Handle that identifies the Communication context returned from
|
|
SCardEstablishContext/ Handle to be released.
|
|
</member>
|
|
<member name="M:NA2WNFC.NativeMethods.SCardListReaders(System.Int32,System.Byte[],System.Byte[],System.Int32@)">
|
|
The ScardListReaders functions returns a list of currently available readers on
|
|
the system, optionally filtered by a set of named reader groups. Application must parse the buffer
|
|
storing names of readers to retrieve the name of individual reader. mszReaders is a pointer
|
|
to a character string that is allocated by the application. If the application sends szReaders
|
|
as NULL then this function returns the size of the buffer needed to allocate in pcchReaders.
|
|
If value pointed by pcchReaders is specified as SCARD_AUTOALLOCATE, then mszReaders is casted
|
|
as a pointer to a pointer, and receives the address of a block of memory containing the
|
|
character string, allocated by the PC/SC API. This block of memory must be deallocated by the
|
|
calling application with SCardFreeMemory. On success, mszReaders is a multi-string and separated
|
|
by a null character ('\0') and ended by a double null character (e.g. "Reader A\0Reader B\0\0").
|
|
|
|
Parameters: hContext(in) - Connection context to the PC/SC Resource Manager/ Handle that identifies the
|
|
communication context for the query (returned from a previous call to SCardEstablish
|
|
Context).
|
|
mszGroups(in) - List of groups to list readers/ Name of reader groups defined in the system. Use NULL here.
|
|
MszReaders(out) - Multi-string buffer with list of readers. Reader names are separated by NULL characters.
|
|
pcchReaders(in) - Max. length of mszReaders
|
|
(out) - Actual Length of the multi-string buffer in characters including NULL.
|
|
</member>
|
|
<member name="M:NA2WNFC.NativeMethods.SCardConnect(System.Int32,System.String,System.Int32,System.Int32,System.Int32@,System.Int32@)">
|
|
The SCardConnect function establishes a connection between the calling application and a specific
|
|
reader.
|
|
|
|
Parameters: hContext(in) - Connection context to the PC/SC Resource Manager/ Handle that identifies
|
|
the communication context returned from a previous call to SCardEstablish
|
|
Context.
|
|
szReader(in) - The name of the reader
|
|
dwShareMode(in) - Exclusive or shared connection
|
|
dwPreferredProtocols(in) - Bit-mask specifying the list of acceptable card protocols
|
|
phCard(out) - Handle to the reader/ Handle that identifies the connection to the specified
|
|
reader
|
|
pdwActiveProtocol(in) - The smart card protocol to be used in the subsequent communication
|
|
(out) - Actual protocol selected by the reader
|
|
</member>
|
|
<member name="T:NA2WNFC.INdefRecordPayload">
|
|
<summary>
|
|
Interface for all type of NFC record payload
|
|
</summary>
|
|
</member>
|
|
<member name="M:NA2WNFC.INdefRecordPayload.ToString">
|
|
<summary>
|
|
Get Payload as String
|
|
</summary>
|
|
</member>
|
|
<member name="M:NA2WNFC.INdefRecordPayload.GetRawData">
|
|
<summary>
|
|
Get Payload as Raw Data
|
|
</summary>
|
|
</member>
|
|
<member name="P:NA2WNFC.INdefRecordPayload.Text_Record_Status_Byte">
|
|
<summary>
|
|
Length of Language Code if the Record is a Text Record
|
|
</summary>
|
|
</member>
|
|
<member name="P:NA2WNFC.INdefRecordPayload.Language_Code">
|
|
<summary>
|
|
Language Code if the Record is a Text Record
|
|
</summary>
|
|
</member>
|
|
<member name="T:NA2WNFC.NdefMessage">
|
|
<summary>
|
|
Class for NDEF Record
|
|
</summary>
|
|
</member>
|
|
<member name="F:NA2WNFC.NdefMessage.rawData">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="F:NA2WNFC.NdefMessage.recordList">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:NA2WNFC.NdefMessage.#ctor(System.Byte[])">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="rawData"></param>
|
|
</member>
|
|
<member name="T:NA2WNFC.NdefRecord">
|
|
<summary>
|
|
Class for NDEF Record
|
|
</summary>
|
|
</member>
|
|
<member name="P:NA2WNFC.NdefRecord.Payload">
|
|
<summary>
|
|
Actual Payload of NDEF Record
|
|
</summary>
|
|
</member>
|
|
<member name="P:NA2WNFC.NdefRecord.Is_Text_Record">
|
|
<summary>
|
|
Indicates if the NDEF Record is a Text Record
|
|
</summary>
|
|
</member>
|
|
<member name="P:NA2WNFC.NdefRecord.RecordSize">
|
|
<summary>
|
|
Size of NDEF Record in number of Bytes
|
|
</summary>
|
|
</member>
|
|
<member name="T:NA2WNFC.NdefRecord.SensusNdefRecordType">
|
|
<summary>
|
|
All avaliable types of NDEF Record in Sensus NA2W products
|
|
</summary>
|
|
</member>
|
|
<member name="F:NA2WNFC.NdefRecord.SensusNdefRecordType.ProductDetailsRecord">
|
|
<summary>
|
|
NA2W Product Details Record
|
|
</summary>
|
|
</member>
|
|
<member name="F:NA2WNFC.NdefRecord.SensusNdefRecordType.CRCRecord">
|
|
<summary>
|
|
NA2W CRC Record
|
|
</summary>
|
|
</member>
|
|
<member name="F:NA2WNFC.NdefRecord.SensusNdefRecordType.MeterReadRecord">
|
|
<summary>
|
|
NA2W Meter Read Record
|
|
</summary>
|
|
</member>
|
|
<member name="F:NA2WNFC.NdefRecord.RecordType">
|
|
<summary>
|
|
Type of Record
|
|
</summary>
|
|
</member>
|
|
<member name="M:NA2WNFC.NdefRecord.Parse(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Parse a standard NDEF record from raw data
|
|
</summary>
|
|
</member>
|
|
<member name="P:NA2WNFC.NdefRecordText.Text_Record_Status_Byte">
|
|
<summary>
|
|
Length of Language Code if the Record is a Text Record
|
|
</summary>
|
|
</member>
|
|
<member name="P:NA2WNFC.NdefRecordText.Language_Code">
|
|
<summary>
|
|
Language Code if the Record is a Text Record
|
|
</summary>
|
|
</member>
|
|
<member name="T:NA2WNFC.NFCReader">
|
|
<summary>
|
|
NFC Reader class to use HID Omnikey reader
|
|
</summary>
|
|
</member>
|
|
<member name="P:NA2WNFC.NFCReader.AvailableReaders">
|
|
<summary>
|
|
List of Available Readers
|
|
</summary>
|
|
</member>
|
|
<member name="P:NA2WNFC.NFCReader.TagSerialNumber">
|
|
<summary>
|
|
Serial number of the NFC Tag
|
|
</summary>
|
|
</member>
|
|
<member name="P:NA2WNFC.NFCReader.ReaderName">
|
|
<summary>
|
|
Currently Selected Reader
|
|
</summary>
|
|
</member>
|
|
<member name="P:NA2WNFC.NFCReader.EnableLogging">
|
|
<summary>
|
|
Enable or Disable failure logging
|
|
</summary>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.#ctor(System.String,System.Byte,System.Byte)">
|
|
<summary>
|
|
Create a new instance of NFC Reader type
|
|
</summary>
|
|
<param name="readername">Full Readername as string e.g. "HID Global OMNIKEY 5022 Smart Card Reader 0"</param>
|
|
<param name="RMA_Start_Block">Starting Block Address of RMA data, 0 if there is no RMA data</param>
|
|
<param name="RMA_Last_Block">Last Block Address of RMA data, 0 if there is no RMA data</param>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.GetAvailableReaders">
|
|
<summary>
|
|
Get the list of Available Readers
|
|
</summary>
|
|
<param></param>
|
|
<returns>The list of available readers, empty list otherwise </returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.ConnectReaderDoInventory">
|
|
<summary>
|
|
Connect to the NFC Reader and do an Inventory. This function must be called first before using any other function
|
|
from this library. This function will automatically select the first tag.
|
|
</summary>
|
|
<param></param>
|
|
<returns>0 if the Connection was successful, -1 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.ConnectReader">
|
|
<summary>
|
|
Connect to the the NFC Reader. This function must be called first before using any other function
|
|
from this library. Call Inventory() after this function.
|
|
</summary>
|
|
<param></param>
|
|
<returns>0 if the Connection was successful, -1 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Inventory">
|
|
<summary>
|
|
Connect to the the NFC Reader. This function must be called first before using any other function
|
|
from this library
|
|
</summary>
|
|
<param></param>
|
|
<returns>0 if the Connection was successful, -1 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.DisconnectReader">
|
|
<summary>
|
|
Disconnect the NFC Reader.
|
|
</summary>
|
|
<param></param>
|
|
<returns>0 if the Disconnection was successful, -1 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.ReleaseReader">
|
|
<summary>
|
|
Release the NFC Reader. This function must be the last function to call
|
|
</summary>
|
|
<param></param>
|
|
<returns>0 if the release was successful, -1 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.IsConnected">
|
|
<summary>
|
|
Check whether the NFC reader is succesfully connected
|
|
</summary>
|
|
<param></param>
|
|
<returns>True if it is connected, false otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_RawData">
|
|
<summary>
|
|
Read the whole NDEF message from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>byte array if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_Records">
|
|
<summary>
|
|
Read all the NDEF records from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>List of NdefRecords if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Product_Details_Record">
|
|
<summary>
|
|
Read the Product Details Record from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>Product Details Record if reading was successfull, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Meter_Read_Record">
|
|
<summary>
|
|
Read the Meter Read Record from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>Meter Read Record if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_Product_Details_Identifier">
|
|
<summary>
|
|
Read the Product Details Identifier from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>Product Details Identifier string if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_Product_Type">
|
|
<summary>
|
|
Read the Product Type from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>Product Type string if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_Product_Type_Version">
|
|
<summary>
|
|
Read the Product Type Version from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>Product Type Version string if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_ID1">
|
|
<summary>
|
|
Read ID1 from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>ID1 string if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_ID2">
|
|
<summary>
|
|
Read ID2 from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>ID2 string if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_ID3">
|
|
<summary>
|
|
Read ID3 from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>ID3 string if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_ID4">
|
|
<summary>
|
|
Read ID4 from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>ID4 string if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_BoardID">
|
|
<summary>
|
|
Read Board ID from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>Board ID string if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_VariantID">
|
|
<summary>
|
|
Read Variant ID from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>Variant ID string if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_Meter_Read_Identifier">
|
|
<summary>
|
|
Read Meter Read Identifier from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>Meter Read Identifier string if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_Meter_Volume">
|
|
<summary>
|
|
Read Meter Volume from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>Meter Volume string if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_Meter_Unit">
|
|
<summary>
|
|
Read Meter Unit from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>Meter Unit string if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_Meter_DateTime">
|
|
<summary>
|
|
Read Meter DateTime from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>Meter DateTime string if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Ndef_ChecksumString">
|
|
<summary>
|
|
Read Checksum string from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>Checksum string if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_Parse_Ndef_Checksum">
|
|
<summary>
|
|
Read and Parse Checksum Value from the tag
|
|
</summary>
|
|
<param></param>
|
|
<returns>Checksum value if reading was successful, 0 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_RawData(System.Boolean,System.String)">
|
|
<summary>
|
|
Read RMA Raw Data from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>Byte array of Raw Data if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_MapRev(System.Boolean,System.String)">
|
|
<summary>
|
|
Read RMA Map Revision from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>RMA Map Revision if reading was successful, 0 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_StorageSize(System.Boolean,System.String)">
|
|
<summary>
|
|
Read RMA Storage Size from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>RMA Storage Size if reading was successful, 0 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_Spare(System.Boolean,System.String)">
|
|
<summary>
|
|
Read RMA Spare Bytes from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>RMA Spare Bytes if reading was successful, 0 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_NumOfResets(System.Boolean,System.String)">
|
|
<summary>
|
|
Read Number of Resets from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>Number of Resets if reading was successful, 0 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_NumOfWDResets(System.Boolean,System.String)">
|
|
<summary>
|
|
Read Number of WatchDog Resets from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>Number of WatchDog Resets if reading was successful, 0 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_ResetReasons(System.Boolean,System.String)">
|
|
<summary>
|
|
Read Reset Reasons from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>List of Reset Reasons if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_ResetTime(System.Boolean,System.String)">
|
|
<summary>
|
|
Read Reset Time from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>List of Reset Time if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_UpdateTime(System.Boolean,System.String)">
|
|
<summary>
|
|
Read RMA Update Time from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>RMA Update Time if reading was successful, 0 otherwise.</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_SecondsBatActive(System.Boolean,System.String)">
|
|
<summary>
|
|
Read Number of Battery Active Seconds from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>Number of Battery Active Seconds if reading was successful, 0 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_SecondsInstallation(System.Boolean,System.String)">
|
|
<summary>
|
|
Read Number of Seconds Since Installation from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>Number of Seconds Since Installation if reading was successful, 0 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_VolumeReading(System.Boolean,System.String)">
|
|
<summary>
|
|
Read Volume Reading from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>Volume Reading if reading was successful, 0 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_LifeTimeTotalizer(System.Boolean,System.String)">
|
|
<summary>
|
|
Read Life Time Totalizer from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>Life Time Totalizer if reading was successful, 0 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_SecondsTestTotalizerActive(System.Boolean,System.String)">
|
|
<summary>
|
|
Read Test Totalizer Active Seconds from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>Test Totalizer Active Seconds if reading was successful, 0 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_PreDefAlarmInfo(System.Boolean,System.String)">
|
|
<summary>
|
|
Read PreDefined Alarms Info from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>PreDefined Alarms Info if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_PreDefAlarmInfo_Raw(System.Boolean,System.String)">
|
|
<summary>
|
|
Read PreDefined Alarm Info from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>PreDefined Alarm Info if reading was successful, 0 otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_UserDefAlarmInfo(System.Boolean,System.String)">
|
|
<summary>
|
|
Read User Defined Alarms Info from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>User Defined Alarms Info if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_UserDefAlarmInfo_Raw(System.Boolean,System.String)">
|
|
<summary>
|
|
Read User Defined Alarm Info from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>User Defined Alarm Info if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_AdapterFactoryID(System.Boolean,System.String)">
|
|
<summary>
|
|
Read Adapter Factory ID from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>Adapter Factory ID if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_AdapterFactoryID_Raw(System.Boolean,System.String)">
|
|
<summary>
|
|
Read Adapter Factory ID from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>Adapter Factory ID if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_AdapterFWVersion(System.Boolean,System.String)">
|
|
<summary>
|
|
Read Adapter Firmware Version from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>Adapter Firmware Version if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.Read_RMA_AdapterFWVersion_Raw(System.Boolean,System.String)">
|
|
<summary>
|
|
Read Adapter Firmware Version from the tag
|
|
</summary>
|
|
<param name="passwordprotected">True if RMA is password protected, False otherwise</param>
|
|
<param name="password">RMA area password as a Hex string without "0x" and spaces,if RMA is password protected and RMA password is different
|
|
from defaul password. If RMA is not password protected or RMA password is a default password, use empty string as a parameter</param>
|
|
<returns>Adapter Firmware Version if reading was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.SendMailboxMessage(System.Byte[],System.TimeSpan)">
|
|
<summary>
|
|
Send Receive Mailbox Message
|
|
</summary>
|
|
<param name="message">Message array</param>
|
|
<param name="timeout">Timeout for Response from the tag</param>
|
|
<returns>Received Message if transaction was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.SendMailbox_FlexNet_Serial_Ping(System.TimeSpan)">
|
|
<summary>
|
|
Send FlexNet Serial Ping through Mailbox
|
|
</summary>
|
|
<param name="timeout">Timeout for Response from the tag</param>
|
|
<returns>"1B019C01006215" if transaction was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="M:NA2WNFC.NFCReader.ReadMailboxMessage(System.TimeSpan)">
|
|
<summary>
|
|
Receive Mailbox Message
|
|
</summary>
|
|
<param name="timeout">Timeout for Response from the tag</param>
|
|
<returns>Received Message if transaction was successful, null otherwise</returns>
|
|
</member>
|
|
<member name="T:NA2WNFC.Properties.Resources">
|
|
<summary>
|
|
A strongly-typed resource class, for looking up localized strings, etc.
|
|
</summary>
|
|
</member>
|
|
<member name="P:NA2WNFC.Properties.Resources.ResourceManager">
|
|
<summary>
|
|
Returns the cached ResourceManager instance used by this class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:NA2WNFC.Properties.Resources.Culture">
|
|
<summary>
|
|
Overrides the current thread's CurrentUICulture property for all
|
|
resource lookups using this strongly typed resource class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:NA2WNFC.RMAPreDefinedAlarms">
|
|
<summary>
|
|
Class for PreDefined Alarms
|
|
</summary>
|
|
</member>
|
|
<member name="M:NA2WNFC.RMAPreDefinedAlarms.#ctor(System.UInt64)">
|
|
<summary>
|
|
Create a new instance of RMA PreDefined Alarms
|
|
</summary>
|
|
<param name="info">8 bytes Raw data of PreDefined Alarms from RMA</param>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_UpgradeMode">
|
|
<summary>
|
|
Get the last known state of Upgrade Mode Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_SevereHardwareFailure">
|
|
<summary>
|
|
Get the last known state of Severe Hardware Failure Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_NVMemoryError">
|
|
<summary>
|
|
Get the last known state of NV Memory Error Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_DeadBattery">
|
|
<summary>
|
|
Get the last known state of Dead Battery Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_EmptyPipe">
|
|
<summary>
|
|
Get the last known state of Empty Pipe Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_MagneticTamper">
|
|
<summary>
|
|
Get the last known state of Magnetic Tamper Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_MeterDisconnectTamper">
|
|
<summary>
|
|
Get the last known state of Meter Disconnect Tamper Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_NearEndOfLife">
|
|
<summary>
|
|
Get the last known state of Near End Of Life Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_BeyondEndOfLife">
|
|
<summary>
|
|
Get the last known state of Beyond End Of Life Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_MetrologyCommError">
|
|
<summary>
|
|
Get the last known state of Metrology Comm Error Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_CriticalHardwareWarning">
|
|
<summary>
|
|
Get the last known state of Critical Hardware Warning Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_Reboot">
|
|
<summary>
|
|
Get the last known state of Reboot Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_EMFRange">
|
|
<summary>
|
|
Get the last known state of EMF Range Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_LowField">
|
|
<summary>
|
|
Get the last known state of Low Field Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_HighCurrent">
|
|
<summary>
|
|
Get the last known state of High Current Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_LowPrimaryBattery">
|
|
<summary>
|
|
Get the last known state of Low Primary Battery Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_LowSecondaryBattery">
|
|
<summary>
|
|
Get the last known state of Low Secondary Battery Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_GlideSlope">
|
|
<summary>
|
|
Get the last known state of Glide Slope Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_HighTemperature">
|
|
<summary>
|
|
Get the last known state of High Temperature Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_ConfigError">
|
|
<summary>
|
|
Get the last known state of Config Error Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_ActuatorFailure">
|
|
<summary>
|
|
Get the last known state of Actuator Failure Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAPreDefinedAlarms.PreDef_Alarm_HumiditySensorRead">
|
|
<summary>
|
|
Get the last known state of Humidity Sensor Read Alarm
|
|
</summary>
|
|
<returns>Alarm State Vector Entry</returns>
|
|
</member>
|
|
<member name="T:NA2WNFC.RMAUserDefinedAlarms">
|
|
<summary>
|
|
Class for User Defined Alarms
|
|
</summary>
|
|
</member>
|
|
<member name="M:NA2WNFC.RMAUserDefinedAlarms.#ctor(System.Collections.Generic.IEnumerable{System.Byte})">
|
|
<summary>
|
|
Create a new instance of RMA User Defined Alarms
|
|
</summary>
|
|
<param name="info">10 bytes Raw data of User Defined Alarms from RMA</param>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAUserDefinedAlarms.User_Defined_Alarm_Slot_0_Defintion">
|
|
<summary>
|
|
Get the defintion(type) of User Defined Alarm in Slot 0
|
|
</summary>
|
|
<returns>Enumeration value representing the type of alarm</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAUserDefinedAlarms.User_Defined_Alarm_Slot_1_Defintion">
|
|
<summary>
|
|
Get the defintion(type) of User Defined Alarm in Slot 1
|
|
</summary>
|
|
<returns>Enumeration value representing the type of alarm</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAUserDefinedAlarms.User_Defined_Alarm_Slot_2_Defintion">
|
|
<summary>
|
|
Get the defintion(type) of User Defined Alarm in Slot 2
|
|
</summary>
|
|
<returns>Enumeration value representing the type of alarm</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAUserDefinedAlarms.User_Defined_Alarm_Slot_3_Defintion">
|
|
<summary>
|
|
Get the defintion(type) of User Defined Alarm in Slot 3
|
|
</summary>
|
|
<returns>Enumeration value representing the type of alarm</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAUserDefinedAlarms.User_Defined_Alarm_Slot_0_State">
|
|
<summary>
|
|
Get the last known state of User Defined Alarm in Slot 0
|
|
</summary>
|
|
<returns>true if the alarm condition is present, false otherwise</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAUserDefinedAlarms.User_Defined_Alarm_Slot_1_State">
|
|
<summary>
|
|
Get the last known state of User Defined Alarm in Slot 1
|
|
</summary>
|
|
<returns>true if the alarm condition is present, false otherwise</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAUserDefinedAlarms.User_Defined_Alarm_Slot_2_State">
|
|
<summary>
|
|
Get the last known state of User Defined Alarm in Slot 2
|
|
</summary>
|
|
<returns>true if the alarm condition is present, false otherwise</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAUserDefinedAlarms.User_Defined_Alarm_Slot_3_State">
|
|
<summary>
|
|
Get the last known state of User Defined Alarm in Slot 3
|
|
</summary>
|
|
<returns>true if the alarm condition is present, false otherwise</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAUserDefinedAlarms.User_Defined_Alarm_Slot_0_ID">
|
|
<summary>
|
|
Get the ID of User Defined Alarm in Slot 0
|
|
</summary>
|
|
<returns>ID Value representing the alarm</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAUserDefinedAlarms.User_Defined_Alarm_Slot_1_ID">
|
|
<summary>
|
|
Get the ID of User Defined Alarm in Slot 1
|
|
</summary>
|
|
<returns>ID Value representing the alarm</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAUserDefinedAlarms.User_Defined_Alarm_Slot_2_ID">
|
|
<summary>
|
|
Get the ID of User Defined Alarm in Slot 2
|
|
</summary>
|
|
<returns>ID Value representing the alarm</returns>
|
|
</member>
|
|
<member name="P:NA2WNFC.RMAUserDefinedAlarms.User_Defined_Alarm_Slot_3_ID">
|
|
<summary>
|
|
Get the ID of User Defined Alarm in Slot 3
|
|
</summary>
|
|
<returns>ID Value representing the alarm</returns>
|
|
</member>
|
|
</members>
|
|
</doc>
|