IStructInstance Interface

Interface representing an instance of a IStructType


Namespace: TwinCAT.TypeSystem
Assembly: TwinCAT.Ads.Abstractions (in TwinCAT.Ads.Abstractions.dll) Version: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470

Syntax

C#

public interface IStructInstance : IInterfaceInstance, 
    ISymbol, IAttributedInstance, IInstance, IBitSize, IRpcCallableInstance

The IStructInstance type exposes the following members.

Properties

 

Name

Description

IStructInstance Interface 1:

Attributes

Gets the Type Attributes.
(Inherited from IAttributedInstance)

IStructInstance Interface 2:

BitSize

Gets the size of the IDataType in bits.
(Inherited from IBitSize)

IStructInstance Interface 3:

ByteSize

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

IStructInstance Interface 4:

Category

Gets the Symbol/Datatype Category
(Inherited from ISymbol)

IStructInstance Interface 5:

Comment

Gets the comment of the IInstance
(Inherited from IInstance)

IStructInstance Interface 6:

DataType

Gets the IDataType of the IInstance.
(Inherited from IInstance)

IStructInstance Interface 7:

HasRpcMethods

Gets a value indicating whether this instance has RPC methods
(Inherited from IInterfaceInstance)

IStructInstance Interface 8:

InstanceName

Gets the name of the instance (without periods (.)
(Inherited from IInstance)

IStructInstance Interface 9:

InstancePath

Gets the relative / absolute access path to the instance (with periods (.))
(Inherited from IInstance)

IStructInstance Interface 10:

IsBitType

Gets a value indicating whether this instance is not basing on a full DataType but instead of some sort of bit mapping
(Inherited from IBitSize)

IStructInstance Interface 11:

IsByteAligned

Indicates that the Size of the Object is Byte aligned (BitSize % 8 == 0)
(Inherited from IBitSize)

IStructInstance Interface 12:

IsContainerType

Gets a value indicating whether this Symbol is acontainer type.
(Inherited from ISymbol)

IStructInstance Interface 13:

IsPersistent

Gets a value indicating whether this ISymbol is persistent.
(Inherited from ISymbol)

IStructInstance Interface 14:

IsPointer

Indicates that the IInstance represents a Pointer type (Pointer TO)
(Inherited from IInstance)

IStructInstance Interface 15:

IsPrimitiveType

Gets a value indicating whether this instance is a primitive type.
(Inherited from ISymbol)

IStructInstance Interface 16:

IsProperty

Gets a value indicating whether IInstance is a property.
(Inherited from IInstance)

IStructInstance Interface 17:

IsReadOnly

Indicates that this instance is read only.
(Inherited from ISymbol)

IStructInstance Interface 18:

IsRecursive

Gets a value indicating whether this instance is recursive.
(Inherited from ISymbol)

IStructInstance Interface 19:

IsReference

Indicates that the IInstance represents a Reference type (REFERENCE TO)
(Inherited from IInstance)

IStructInstance Interface 20:

IsStatic

Gets a value indicating whether this IInstance is static.
(Inherited from IInstance)

IStructInstance Interface 21:

MemberInstances

Gets the member instances of the Struct Instance.
(Inherited from IInterfaceInstance)

IStructInstance Interface 22:

Parent

Gets the parent Symbol
(Inherited from ISymbol)

IStructInstance Interface 23:

RpcMethods

Gets the Method descriptions for the IRpcCallableType
(Inherited from IRpcCallableInstance)

IStructInstance Interface 24:

Size

Gets the size of the object in bytes or Bits dependant on IsBitType
(Inherited from IBitSize)

IStructInstance Interface 25:

SubSymbols

Gets the SubSymbols of the ISymbol
(Inherited from ISymbol)

IStructInstance Interface 26:

TypeName

Gets the name of the DataType that is used for this IInstance.
(Inherited from IInstance)

IStructInstance Interface 27:

ValueEncoding

Gets the value encoding.
(Inherited from IAttributedInstance)

Methods

 

Name

Description

InvokeRpcMethod(String, Object)

Invokes the specified RPC Method
(Inherited from IRpcCallableInstance)

InvokeRpcMethod(String, Object, Object)

Invokes the specified RPC Method
(Inherited from IRpcCallableInstance)

InvokeRpcMethodAsync

Invokes the specified RPC Method asynchronously
(Inherited from IRpcCallableInstance)

TryInvokeRpcMethod(String, Object, Object)

Invokes the specified RPC Method
(Inherited from IRpcCallableInstance)

TryInvokeRpcMethod(String, Object, Object, Object)

Invokes the specified RPC Method
(Inherited from IRpcCallableInstance)

Extension Methods

 

Name

Description

HasExternalDataReferences

Indicates, that the Instance value includes process memory data, that cannot be read in one memory block.
(Defined by DataTypeExtension)

IsExternalDataReference

Indicates, that the field is static or is not part of the parents processimage memory location
(Defined by DataTypeExtension)

Unwrap

Gets the Unwrapped Symbol
(Defined by SymbolExtensions)

Reference

TwinCAT.TypeSystem Namespace

Beckhoff Automation GmbH & Co. KG 2001-2026