Get-TComObject

SYNOPSIS

Gets the actual loaded TCOM objects in the TwinCAT environment.

SYNTAX

NetIdPortList (Default)

Get-TComObject [[-Name] <String[]>] [-ClassId <String[]>] [-Timeout <Int32>]
 [<CommonParameters>]

NetIdPort

Get-TComObject [[-Name] <String[]>] [-ClassId <String[]>] [-NetId <AmsNetId>] [-Timeout <Int32>]
 [<CommonParameters>]

AddressStr

Get-TComObject [[-Name] <String[]>] [-ClassId <String[]>] [-Address] <String> [-Timeout <Int32>]
 [<CommonParameters>]

Session

Get-TComObject [[-Name] <String[]>] [-ClassId <String[]>] -Session <ISession> [-Timeout <Int32>]
 [<CommonParameters>]

DESCRIPTION

This command lists the actually loaded TCOM Objects on the target system.

EXAMPLES

Example 1

PS> Get-TComObject -NetId 1.2.3.4.1.1

Name ObjectId  ClassId State RefCount
----           --------  -------                              ----- --------
IO             50331648  03000000-0000-0000-f000-000000000064 Op    2
I/O Idle Task  50331665  01020001-0000-0000-f000-000000000064 Op    4
PlcCtrl        139460608 08500000-0000-0000-f000-000000000064 Op    9
TcOsRTimeUm    33554432  38e506a5-5b67-4107-9e77-8c8d5e4d6399 Op    39
Router         16777216  01000000-0000-0000-f000-000000000064 Op    22
TcLoader       16777217  01000001-0000-0000-f000-000000000064 Op    4
TComServerTask 16777232  01000010-0000-0000-f000-000000000064 Op    4
TcEventLogger  16777328  01000070-0000-0000-f000-000000000064 Op    2

Getting the TCOM Objects from NetId 1.2.3.4.1.1

PARAMETERS

-Name

Optional TCOM object name filter(s). Wildcards are permitted.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-ClassId

Optional TCOM class identifier filter(s). Wildcards are permitted.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-NetId

The address where to get TCOM Objects. Tab completion: Completes AmsNetId values from currently reachable routes on the local TwinCAT system. The NetId. Null is not a valid value for the NetId parameter!

Type: AmsNetId
Parameter Sets: NetIdPort
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Address

The address(es) where to get the TCOM Objects. This can be the RouteName, NetId, the HostName or the IPAddress. Wildcards are permitted. Tab completion: Completes route names from currently reachable ADS systems on the local TwinCAT system. The address.

Type: String
Parameter Sets: AddressStr
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Session

The Session to use for the Cmdlet, must be connected to port 10, R0_TComServer The Session.

Type: ISession
Parameter Sets: Session
Aliases: InputObject

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Timeout

The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms). The ADS communication timeout in milliseconds.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: -1
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

TwinCAT.ISession

OUTPUTS

NOTES