• Api Documentation
  • Programmer's Guide
Show / Hide Table of Contents
  • rfid.api
    • ACCESS_OPERATION_CODE
    • ACCESS_OPERATION_STATUS
    • AccessFilter
    • AccessOperationResult
    • Actions
    • ALARM_LEVEL
    • ANTENNA_EVENT_TYPE
    • ANTENNA_MODE
    • ANTENNA_STOP_TRIGGER_TYPE
    • AntennaConfig
    • AntennaInfo
    • AntennaPortInfo
    • Antennas
    • Antennas.AntennaProperties
    • Antennas.AntennaRfConfig
    • Antennas.AntennaRfConfig.AntennaStopTrigger
    • Antennas.Config
    • Antennas.PhysicalProperties
    • Antennas.RFMode
    • Antennas.SingulationControl
    • Antennas.SingulationControl.SingulationAction
    • BATTERY_STATUS
    • BrandIDCheck
    • CABLE_LOSS_COMPENSATION
    • CableLossCompensation
    • CAPIEvents
    • CAPIEvents.RFSurveyReadNotifyHandler
    • chan_s
    • CHANNEL_TIMING
    • COMMUNICATION_STANDARD
    • COMMUNICATION_STANDARDS
    • CommunicationsStandardCode
    • CommunicationStandard
    • Config
    • COUNTRY_CODE
    • DISCONNECTION_EVENT_TYPE
    • DIVIDE_RATIO
    • Events
    • Events.AccessStartEventData
    • Events.AccessStopEventData
    • Events.AntennaEventData
    • Events.BufferFullWarningEventData
    • Events.DebugInfoEventData
    • Events.DisconnectionEventData
    • Events.GPIEventData
    • Events.HandheldTriggerEventData
    • Events.InventoryStartEventData
    • Events.InventoryStopEventData
    • Events.NXPEASAlarmEventData
    • Events.ReaderExceptionEventData
    • Events.ReadEventArgs
    • Events.ReadEventData
    • Events.ReadNotifyHandler
    • Events.RFSurvayStartEventData
    • Events.RFSurveyEventArgs
    • Events.RFSurveyEventData
    • Events.RFSurveyStopEventData
    • Events.STATUS_EVENT_TYPE
    • Events.StatusEventArgs
    • Events.StatusEventData
    • Events.StatusNotifyHandler
    • Events.TemperatureAlarmData
    • FILTER_ACTION
    • FORWARD_LINK_MODULATION
    • FrequencyHopInfo
    • FrequencyHopTable
    • Fujitsu
    • Fujitsu.AreaReadLockAccessParams
    • Fujitsu.AreaWriteLockAccessParams
    • Fujitsu.AreaWriteLockWOPasswordAccessParams
    • Fujitsu.BurstEraseAccessParams
    • Fujitsu.BurstWriteAccessParams
    • Fujitsu.ChangeBlockLockAccessParams
    • Fujitsu.ChangeBlockOrAreaGroupPasswordAccessParams
    • Fujitsu.ChangeWordLockAccessParams
    • Fujitsu.ReadBlockLockAccessParams
    • FujitsuBurstEraseResult
    • FujitsuBurstWriteResult
    • FujitsuReadBlockLockResult
    • FujitsuStats
    • GPI_PORT_STATE
    • GPIs
    • GPIs.GPI_PORT_STATE
    • GPIs.Port
    • GPITrigger
    • GPOs
    • GPOs.GPO_PORT_STATE
    • GPOs.Port
    • HANDHELD_TRIGGER_EVENT_TYPE
    • HandheldTrigger
    • HEALTH_STATUS
    • Impinj
    • Impinj.QTData
    • Impinj.QTReadAccessParams
    • Impinj.QTWriteAccessParams
    • ImpinjStats
    • InvalidUsageException
    • Inventory
    • INVENTORY_STATE
    • LED_COLOR
    • LedInfo
    • LLRPConnection
    • LLRPConnectionConfig
    • LocationInfo
    • LOCK_DATA_FIELD
    • LOCK_PRIVILEGE
    • LoginInfo
    • MATCH_PATTERN
    • MATCH_RANGE
    • MEMORY_BANK
    • MODULATION
    • NGE_REGUALTORY_CODE
    • NGE_Regulatory_Configuration
    • NGERegion
    • NgeRegionConfig
    • NXP
    • NXP.ChangeConfigParams
    • NXP.ChangeConfigResult
    • NXP.ReadProtectParams
    • NXP.ResetReadProtectParams
    • NXP.SetEASParams
    • NXPStats
    • OPERATION_QUALIFER
    • OperationFailureException
    • PerAntennaReceiveSensitivityRange
    • PeriodicTrigger
    • PixieEvents
    • PostFilter
    • POWER_NEGOTIATION_STATUS
    • POWER_SOURCE_TYPE
    • PreFilters
    • PreFilters.PreFilter
    • PreFilters.StateAwareActionParams
    • PreFilters.StateUnawareAction
    • Profile
    • RADIO_POWER_STATE
    • RadioConfigUpdate
    • RadioFirmwareUpdate
    • READER_EXCEPTION_EVENT_TYPE
    • READER_ID_TYPE
    • READER_TYPE
    • ReaderCapabilities
    • ReaderCapabilities.ReaderIdentification
    • ReaderInfo
    • ReaderManagement
    • ReaderMinorState
    • ReaderModuleVersion
    • ReaderOperation
    • ReaderRegion
    • ReaderRegion.ActiveRegionInfo
    • ReaderRegion.CommunicationStandardInfo
    • ReaderState
    • ReaderStatistics
    • ReaderType
    • ReadPoint
    • READPOINT_STATUS
    • RECOMMISSION_OPERATION_CODE
    • REG_REGION_DOMAIN
    • REGION_CODE
    • REGION_CONFIG_DATA
    • RegionConfig
    • regLBT
    • regOnOff
    • REGULATORY_CONFIG_DATA
    • REGULATORY_LINKPROFILE_DATA
    • ReportTriggers
    • RFID_EVENT_TYPE
    • RFID_SKU
    • RfidApi4Abstract
    • RfidGlobalData
    • RFIDReader
    • RFIDResults
    • RFIDTransportType
    • RFModes
    • RFModeTable
    • RFModeTableEntry
    • RFSurvey
    • RFSURVEY_EVENT_REPORT_TRIGGER
    • RFSurveyData
    • RFSurveyEventReportInfo
    • RssiRangeFilter
    • SECURE_MODE
    • SecureConnectionInfo
    • SecureModeConfig
    • SeenTime
    • SERVICE_ID
    • SESSION
    • SL_FLAG
    • SoftwareUpdate
    • SoftwareUpdateInfo
    • SPECTRAL_MASK_INDICATOR
    • STANDARD_INFO_LISTW
    • STANDARD_REGION_INFOW
    • START_TRIGGER_TYPE
    • StartTrigger
    • STATE_AWARE_ACTION
    • STATE_UNAWARE_ACTION
    • STOP_TRIGGER_TYPE
    • StopTrigger
    • SUPPORTED_BAUDRATE
    • SystemInfo
    • TAG_EVENT
    • TAG_EVENT_REPORT_TRIGGER
    • TAG_FIELD
    • TagAccess
    • TagAccess.BlockEraseAccessParams
    • TagAccess.BlockPermalockAccessParams
    • TagAccess.KillAccessParams
    • TagAccess.LockAccessParams
    • TagAccess.ReadAccessParams
    • TagAccess.RecommisionAccessParams
    • TagAccess.Sequence
    • TagAccess.Sequence.Operation
    • TagAccess.WriteAccessParams
    • TagAccess.WriteSpecificFieldAccessParams
    • TagData
    • TagEventReportInfo
    • TagLocationing
    • TagPatternBase
    • TagStorageSettings
    • TagZoneInfo
    • TARGET
    • TEMPERATURE_SOURCE
    • TemperatureStatus
    • TimeZone
    • TRACE_LEVEL
    • TriggerInfo
    • TriggerWithTimeout
    • TRUNCATE_ACTION
    • UpdateStatus
    • UpTime
    • USB_OPERATION_MODE
    • USBOperationMode
    • UserApp
    • UserAppInfo
    • UserInfo
    • UTCTime
    • VersionInfo
    • WRITE_FIELD_CODE
    • Zones
    • Zones.ZoneConfig
    • ZoneSequence
    • ZoneSequence.ZoneInfo

Class TagAccess

This class handles all the Tag Access operations. Access operations include Read, Write, Lock, Kill, BlockWrite, BlockErase.

Inheritance
System.Object
TagAccess
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: rfid.api
Assembly: rfid.netcore.dll
Syntax
public class TagAccess

Fields

Fujitsu

Used to perform Fujitsu's custom operations on both 8K and 64K Fujitsu tags.

Declaration
public Fujitsu Fujitsu
Field Value
Type Description
Fujitsu

Impinj

Used to perform Impinj's custom operations like QTWrite, QTRead.

Declaration
public Impinj Impinj
Field Value
Type Description
Impinj

NXP

Used to call perform NXP's operations like SetEAS,ReadProtect,ResetReadProtect

Declaration
public NXP NXP
Field Value
Type Description
NXP

OperationSequence

Used to perform a sequence of Access operations.

Declaration
public TagAccess.Sequence OperationSequence
Field Value
Type Description
TagAccess.Sequence

Methods

BlockEraseEvent(TagAccess.BlockEraseAccessParams, AccessFilter, AntennaInfo)

This method is used to perform Block-Erase on tags that match the AccessFilter criteria if specified. Completion of Access operation will be reported as Events.StatusNotify event of type ACCESS_STOP_EVENT.

Declaration
public void BlockEraseEvent(TagAccess.BlockEraseAccessParams blockEraseAccessParams, AccessFilter accessFilter, AntennaInfo antennaInfo)
Parameters
Type Name Description
TagAccess.BlockEraseAccessParams blockEraseAccessParams

Parameters required for the Block-Erase operation.

AccessFilter accessFilter

Access Filter which determines the Tags on which the Access operation is to be performed. If this is null, operation will be perfomed without any access filters.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

BlockEraseWait(String, TagAccess.BlockEraseAccessParams, AntennaInfo)

This method is used to perform Block-Erase operation on a specific tag.

Declaration
public void BlockEraseWait(string tagID, TagAccess.BlockEraseAccessParams blockEraseAccessParams, AntennaInfo antennaInfo)
Parameters
Type Name Description
System.String tagID

EPC-ID of the Tag on which the Block-Erase operation is to be performed.

TagAccess.BlockEraseAccessParams blockEraseAccessParams

Parameters required for the Block-Erase operation.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

BlockPermalockEvent(TagAccess.BlockPermalockAccessParams, AccessFilter, AntennaInfo)

Allows to permalock multiple words in a Tag’s Reserved, EPC, TID, or User memory with a single command, or read the permalock satus of the memory blocks in a Tag's User memory

Declaration
public void BlockPermalockEvent(TagAccess.BlockPermalockAccessParams blockPermalockAccessParams, AccessFilter accessFilter, AntennaInfo antennaInfo)
Parameters
Type Name Description
TagAccess.BlockPermalockAccessParams blockPermalockAccessParams

Parameters required for the operation.

AccessFilter accessFilter

Access Filter which determines the Tags on which the Access operation is to be performed. If this is null, operation will be perfomed without any access filters.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

BlockPermalockWait(String, TagAccess.BlockPermalockAccessParams, AntennaInfo)

Allows to permalock multiple words in a Tag’s Reserved, EPC, TID, or User memory with a single command, or read the permalock status of the memory blocks in a Tag's User memory

Declaration
public TagData BlockPermalockWait(string tagID, TagAccess.BlockPermalockAccessParams blockPermalockAccessParams, AntennaInfo antennaInfo)
Parameters
Type Name Description
System.String tagID

Access-Operation will be performed on Tag with mentioned TagID.

TagAccess.BlockPermalockAccessParams blockPermalockAccessParams

Parameters required for the operation.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

Returns
Type Description
TagData

TagData corresponding to the Tag on which the BlockPermalock operation was performed.

BlockWriteEvent(TagAccess.WriteAccessParams, AccessFilter, AntennaInfo)

This method is used to Block-Write on tags that match the AccessFilter criteria if specified. Completion of Access operation will be reported as Events.StatusNotify event of type ACCESS_STOP_EVENT.

Declaration
public void BlockWriteEvent(TagAccess.WriteAccessParams writeAccessParams, AccessFilter accessFilter, AntennaInfo antennaInfo)
Parameters
Type Name Description
TagAccess.WriteAccessParams writeAccessParams

Parameters required for the Block write operation.

AccessFilter accessFilter

Access Filter which determines the Tags on which the Access operation is to be performed. If this is null, operation will be perfomed without any access filters.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

BlockWriteWait(String, TagAccess.WriteAccessParams, AntennaInfo)

This method is used to perform Block-Write operation on a specific tag.

Declaration
public void BlockWriteWait(string tagID, TagAccess.WriteAccessParams writeAccessParams, AntennaInfo antennaInfo)
Parameters
Type Name Description
System.String tagID

EPC-ID of the Tag on which the Block-Write operation is to be performed.

TagAccess.WriteAccessParams writeAccessParams

Parameters required for the Block-Write operation.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

Finalize()

Destructor

Declaration
protected void Finalize()

GetLastAccessResult(ref UInt32, ref UInt32)

This method retrives the result of the last performed access operation. If the last access operation was an Access Sequence, the result indicates the number of tags on which all the operations in the Access Sequence was a success. If atleast one operatin failed, that tag will be counted as failed.

Declaration
public void GetLastAccessResult(ref uint successCount, ref uint failureCount)
Parameters
Type Name Description
System.UInt32 successCount

Number of Tags on which the operation succeeded

System.UInt32 failureCount

Number of Tags on which the operation failed

KillEvent(TagAccess.KillAccessParams, AccessFilter, AntennaInfo)

This method is used to kill tags that match the AccessFilter criteria if specified. Completion of Access operation will be reported as Events.StatusNotify event of type ACCESS_STOP_EVENT.

Declaration
public void KillEvent(TagAccess.KillAccessParams killAccessParams, AccessFilter accessFilter, AntennaInfo antennaInfo)
Parameters
Type Name Description
TagAccess.KillAccessParams killAccessParams

Parameters required for the Kill operation.

AccessFilter accessFilter

Access Filter which determines the Tags on which the Access operation is to be performed. If this is null, operation will be perfomed without any access filters.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

KillWait(String, TagAccess.KillAccessParams, AntennaInfo)

This method is used to kill a specific tag.

Declaration
public void KillWait(string tagID, TagAccess.KillAccessParams killAccessParams, AntennaInfo antennaInfo)
Parameters
Type Name Description
System.String tagID

EPC-ID of the Tag on which the Kill operation is to be performed.

TagAccess.KillAccessParams killAccessParams

Parameters required for the Kill operation.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

LockEvent(TagAccess.LockAccessParams, AccessFilter, AntennaInfo)

This method is used to lock tags that match the AccessFilter criteria if specified. Completion of Access operation will be reported as Events.StatusNotify event of type ACCESS_STOP_EVENT.

Declaration
public void LockEvent(TagAccess.LockAccessParams lockAccessParams, AccessFilter accessFilter, AntennaInfo antennaInfo)
Parameters
Type Name Description
TagAccess.LockAccessParams lockAccessParams

Parameters required for the Lock operation.

AccessFilter accessFilter

Access Filter which determines the Tags on which the Access operation is to be performed. If this is null, operation will be perfomed without any access filters.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

LockWait(String, TagAccess.LockAccessParams, AntennaInfo)

This method is used to lock a specific tag.

Declaration
public void LockWait(string tagID, TagAccess.LockAccessParams lockAccessParams, AntennaInfo antennaInfo)
Parameters
Type Name Description
System.String tagID

EPC-ID of the Tag on which the Lock operation is to be performed.

TagAccess.LockAccessParams lockAccessParams

Parameters required for the Lock operation.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

ReadEvent(TagAccess.ReadAccessParams, AccessFilter, AntennaInfo)

This method is used to read memory bank data from tags that match the AccessFilter criteria if specified. Tags will be reported as notifications if the application has registered for Events.ReadNotify event. Else the Tags will be fetched using GetReadTags(s) methods. Completion of Access operation will be reported as Events.StatusNotify event of type ACCESS_STOP_EVENT.

Declaration
public void ReadEvent(TagAccess.ReadAccessParams readAccessParams, AccessFilter accessFilter, AntennaInfo antennaInfo)
Parameters
Type Name Description
TagAccess.ReadAccessParams readAccessParams

Parameters required for the Read operation.

AccessFilter accessFilter

Access Filter which determines the Tags on which the Access operation is to be performed. If this is null, operation will be perfomed without any access filters.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

ReadWait(String, TagAccess.ReadAccessParams, AntennaInfo)

This method is used to read memory bank data from a specific tag.

Declaration
public TagData ReadWait(string tagID, TagAccess.ReadAccessParams readAccessParams, AntennaInfo antennaInfo)
Parameters
Type Name Description
System.String tagID

EPC-ID of the Tag on which the Read operation is to be performed.

TagAccess.ReadAccessParams readAccessParams

Parameters required for the Read operation.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

Returns
Type Description
TagData

TagData corresponding to the Tag on which the read operation was performed.

RecommisionEvent(TagAccess.RecommisionAccessParams, AccessFilter, AntennaInfo)

Used for recommissioning tag(s).

Declaration
public void RecommisionEvent(TagAccess.RecommisionAccessParams recommisionAccessParams, AccessFilter accessFilter, AntennaInfo antennaInfo)
Parameters
Type Name Description
TagAccess.RecommisionAccessParams recommisionAccessParams

Parameters required for the operation.

AccessFilter accessFilter

Access Filter which determines the Tags on which the Access operation is to be performed. If this is null, operation will be perfomed without any access filters.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

RecommisionWait(String, TagAccess.RecommisionAccessParams, AntennaInfo)

Used for recommissioning tag(s).

Declaration
public void RecommisionWait(string tagID, TagAccess.RecommisionAccessParams recommisionAccessParams, AntennaInfo antennaInfo)
Parameters
Type Name Description
System.String tagID

Access-Operation will be performed on Tag with mentioned TagID.

TagAccess.RecommisionAccessParams recommisionAccessParams

Parameters required for the operation.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

WriteAccessPasswordWait(String, TagAccess.WriteSpecificFieldAccessParams, AntennaInfo)

This method is used to write the access Password of a specific tag.

Declaration
public void WriteAccessPasswordWait(string tagID, TagAccess.WriteSpecificFieldAccessParams writeSpecificFieldAccessParams, AntennaInfo antennaInfo)
Parameters
Type Name Description
System.String tagID

EPC-ID of the Tag on which the Write operation is to be performed.

TagAccess.WriteSpecificFieldAccessParams writeSpecificFieldAccessParams

Parameters required for writing the access Password of a specific tag.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

WriteEvent(TagAccess.WriteAccessParams, AccessFilter, AntennaInfo)

This method is used to write data to the memory bank data of tags that match the AccessFilter criteria if specified. Completion of Access operation will be reported as Events.StatusNotify event of type ACCESS_STOP_EVENT.

Declaration
public void WriteEvent(TagAccess.WriteAccessParams writeAccessParams, AccessFilter accessFilter, AntennaInfo antennaInfo)
Parameters
Type Name Description
TagAccess.WriteAccessParams writeAccessParams

Parameters required for the Write operation.

AccessFilter accessFilter

Access Filter which determines the Tags on which the Access operation is to be performed. If this is null, operation will be perfomed without any access filters.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

WriteKillPasswordWait(String, TagAccess.WriteSpecificFieldAccessParams, AntennaInfo)

This method is used to write the Kill Password of a specific tag.

Declaration
public void WriteKillPasswordWait(string tagID, TagAccess.WriteSpecificFieldAccessParams writeSpecificFieldAccessParams, AntennaInfo antennaInfo)
Parameters
Type Name Description
System.String tagID

EPC-ID of the Tag on which the Write operation is to be performed.

TagAccess.WriteSpecificFieldAccessParams writeSpecificFieldAccessParams

Parameters required for writing the Kill Password of a specific tag.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

WriteTagIDWait(String, TagAccess.WriteSpecificFieldAccessParams, AntennaInfo)

This method is used to write EPC ID of a specific tag.

Declaration
public void WriteTagIDWait(string tagID, TagAccess.WriteSpecificFieldAccessParams writeSpecificFieldAccessParams, AntennaInfo antennaInfo)
Parameters
Type Name Description
System.String tagID

EPC-ID of the Tag on which the Write operation is to be performed.

TagAccess.WriteSpecificFieldAccessParams writeSpecificFieldAccessParams

Parameters required for writing the EPC write operation.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

WriteWait(String, TagAccess.WriteAccessParams, AntennaInfo)

This method is used to write data to the memory bank of a specific tag.

Declaration
public void WriteWait(string tagID, TagAccess.WriteAccessParams writeAccessParams, AntennaInfo antennaInfo)
Parameters
Type Name Description
System.String tagID

EPC-ID of the Tag on which the Write operation is to be performed.

TagAccess.WriteAccessParams writeAccessParams

Parameters required for the Write operation.

AntennaInfo antennaInfo

Antennas on which the current operation is to be performed. If this is null, operation will be performed on all Antennas.

Back to top