Remove Property Item
Last Modified: February 25, 2024 18:18 CEST

Remove-PropertyItem #

SYNOPSIS #

Removes the record from the properties list.

SYNTAX #

Remove-PropertyItem [[-id] <Int32>] [[-propertyId] <Int32>] [[-conn] <Object>] [[-udl] <String>]
 [[-connStr] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION #

In the ERP system, you can remove a property for example of a delivery bill. The delivery bill is specified by its ID. The connection to the database is made via a connection object, a connection string or the specification of a UDL file.

You can see what a property tree looks like in Example 1.

EXAMPLES #

Example 1:How a property tree looks like #

Delivery Notes/
├─ My Properties/
├─ Delivery Status/
│  ├─ Complete
│  ├─ Over Delivered
│  ├─ Under Delivered
├─ Tracking Information/
│  ├─ Partial Missing
│  ├─ Complete
│  ├─ All Missing
├─ Locked for Retransmission

This property tree is just an example. Using this structure, all delivery bills that are assigned to this property can be displayed immediately in the ERP system. Removing these properties can be done via this API.

Example 2:Removes a property with the specified propertyId from the record #

PS C:\> Remove-DeliveryPropertyItem -Id 2023 -propertyId 125 -udl "C:\temp\Eulanda_1 JohnDoe.udl"

In this example, the property with id 125 is removed from the property tree for the delivery bill with its id 2023. The connection to the database is made via the specified UDL file.

PARAMETERS #

-conn #

The connection can be established via an existing ADO object of the type ‘ADODB.Connection’. If the connection is already open, it remains open even after the function has been executed. If it was closed, it will be closed again after the function has been executed.

Type: Object
Parameter Sets: (All)
Aliases:

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

-connStr #

A ConnectionString can be specified here, with which a database can be opened.

Type: String
Parameter Sets: (All)
Aliases:

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

-id #

The records is specified by its ID.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-propertyId #

The property ID is determined directly in the ERP system by clicking on the property name with the right mouse button and noting the displayed ID.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-udl #

Alternatively to a connection, a string to a UDL file can be specified. In this case an ADO object is created and closed again at the end of the function.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
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 #

None #

OUTPUTS #

System.Object #

NOTES #