TcAdsSymbolInfo Class

The class TcAdsSymbolInfo represents a symbol loaded by an instance of the TcAdsSymbolInfoLoader class.

Inheritance Hierarchy

System.Object
  TwinCAT.Ads.TcAdsSymbolInfo
Namespace:  TwinCAT.Ads
Assembly:  TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 4.3.0.0

Syntax

C#

public class TcAdsSymbolInfo : ITcAdsSymbol5, 
    ITcAdsSymbol4, ITcAdsSymbol3, ITcAdsSymbol2, ITcAdsSymbol, ITcAdsSymbolBrowser

VB

Public Class TcAdsSymbolInfo
    Implements ITcAdsSymbol5, ITcAdsSymbol4, ITcAdsSymbol3, ITcAdsSymbol2, 
    ITcAdsSymbol, ITcAdsSymbolBrowser

The TcAdsSymbolInfo type exposes the following members.

Properties

 

Name

Description

ArrayDimensions

Gets the array dimensions.

ArrayInfos

Gets the collection of Array Infos.

Attributes

Gets the attributes of the ITcAdsSymbol

BitSize

Gets the size of this TcAdsSymbolInfo in bits.

ByteSize

Gets the (aligned) size of of the Type/Instance in Bytes

Category

Gets the Data Type Category

Comment

Gets the comment behind the variable declaration.

ContextMask

Gets the ContextMask of the symbol, indicating the task the variable belongs to. If ContextMask is not zero use CyclicInContext or OnChangeInContext to add notifications.

DataType

Gets the DataType object

DataTypeId

Data type of the symbol.

HasRpcMethods

Gets a value indicating whether this instance has RPC methods (Struct types only)

IndexGroup

Gets the index group of the symbol.

IndexOffset

Gets the index offset of the symbol.

IsBitType

Indicates if the BitValue flag is set for the symbol.

IsOversamplingArray

Gets a value indicating whether this instance is oversampling array.

IsPersistent

Indicates if the Persistent flag is set for the symbol.

IsReadOnly

Indicates if the ReadOnly flag is set for the symbol.

IsStatic

Indicates, that this symbol is a static symbol.

IsTcComInterfacePointer

Indicates if the TcComInterfacePointer flag is set for the symbol.

IsTypeGuid

Indicates if the TypeGuid flag is set for the symbol.

Name

Gets the name of the symbol.

Parent

Gets the parent of this symbol.

RpcMethods

Gets the RPC method descriptions

ShortName

Gets the name of the symbol (short form without prefixed names of the parents).

Size

Gets the size of the symbol.

SubSymbols

Gets the sub symbols of this symbol as a collection of TcAdsSymbolInfo objects.

TypeName

Gets the name of the symbol data type.

Methods

 

Name

Description

Equals

Equals (Overrides Object.Equals(Object).)

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)

GetHashCode

Gets the HashCode of the Address (Overrides Object.GetHashCode..)

GetType

Gets the Type of the current instance. (Inherited from Object.)

IsRecursive

Gets a value indicating whether this instance is recursive.

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

ToString

Returns a String that represents this instance. (Overrides Object.ToString..)

TryGetPointerRef

Gets the Base data type of the pointer (the referenced type)

TryGetReference

Gets the referenced data type of the reference.

Operators

 

Name

Description

Equality

Implements the == operator.

Inequality

Implements the != operator.

Reference

TwinCAT.Ads Namespace

TwinCAT.Ads.ITcAdsSymbol5

TwinCAT.Ads.ITcAdsSymbolBrowser