Documentation Center

  • Trials
  • Product Updates

Properties in OPC Toolbox

  • By Category | Alphabetical List
  • Server Connection and Browsing

    Group Data Access Group objects contained by client
    Name Descriptive name for OPC Toolbox object
    Tag Label to associate with OPC Toolbox object
    Type OPC Toolbox object type
    UserData Data to associate with OPC Toolbox object
    Host DNS name or IP address of server
    ServerID Server identity
    Status Status of connection to OPC server
    Timeout Maximum time to wait for completion of instruction to server

    Data Access

    Item and Group Management

    GroupType Public status of dagroup object
    Item Data Access Item objects contained by group
    Name Descriptive name for OPC Toolbox object
    Parent OPC Toolbox object that contains dagroup or daitem object
    Tag Label to associate with OPC Toolbox object
    TimeBias Time bias of group
    Type OPC Toolbox object type
    UserData Data to associate with OPC Toolbox object
    AccessRights Inherent nature of access to item
    Active Group or item activation state
    ItemID Fully qualified ID on OPC server
    ScanRate Fastest possible data update rate
    CanonicalDataType Server's data type for item
    DataType Client item's data type
    Quality Quality of data value as string
    QualityID Quality of data value as 16-bit integer
    TimeStamp Time when item was last read
    Value Item value

    Data Logs and Buffers

    Active Group or item activation state
    DeadbandPercent Percentage change in item value that causes subscription callback
    LogFileName Name of disk file to which logged data is written
    Logging Status of data logging
    LoggingMode Specify destination for logged data
    LogToDiskMode Method of disk file handling for logged data
    RecordsAcquired Number of records acquired
    RecordsAvailable Number of records available in OPC Toolbox engine
    RecordsToAcquire Number of records to acquire for logging session
    Subscription Enable server update when data changes
    UpdateRate Rate, in seconds, at which subscription callbacks occur

    Events and Callbacks

    ErrorFcn Callback function file to execute when error event occurs
    EventLog Event information log
    EventLogMax Maximum number of events to store in event log
    ShutDownFcn Callback function file to execute when OPC server shuts down
    TimerFcn Callback function file to execute when predefined period passes
    TimerPeriod Period between timer events
    CancelAsyncFcn Callback function file to execute when asynchronous operation is canceled
    DataChangeFcn Callback function file to execute when data change event occurs
    ReadAsyncFcn Callback function file to execute when asynchronous read completes
    RecordsAcquiredFcn Callback function file to execute when RecordsAcquired event occurs
    RecordsAcquiredFcnCount Number of records to acquire before RecordsAcquired event occurs
    StartFcn Callback function file to execute immediately before logging starts
    StopFcn Callback function file to execute immediately after logging stops
    WriteAsyncFcn Callback function file to execute when asynchronous write completes
    Was this topic helpful?