Skip to content

New-FlatReturnObject

SYNOPSIS

Creates an new PSCustomObject from a Easit GO exported item.

SYNTAX

1
New-FlatReturnObject [-Object] <PSObject> [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

New-FlatReturnObject creates a new "flat" PSCustomObject with all properties as members directly to the object. Non "flat" PSCustomObject: $myObject.property.GetEnumerator() | | Where-Object -Property Name -EQ -Value 'wantedProperty' "Flat" PSCustomObject: $myObject.wantedProperty

"Hidden" properties added to the returned PSCustomObject are:

  • ObjectId
  • DatabaseId
  • PropertyObjects
  • propertyName_rawValue (one for each property)
  • Attachments

If a property occurs more than one time, the property value will be an array of all values with that name.

EXAMPLES

EXAMPLE 1

1
2
3
4
5
try {
    New-FlatReturnObject -Object $exportObject.itemToImport[0]
} catch {
    throw $_
}

PARAMETERS

-Object

Object to be "flatten".

1
2
3
4
5
6
7
8
9
Type: PSObject
Parameter Sets: (All)
Aliases: Item

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

-ProgressAction

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.

The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.

1
2
3
4
5
6
7
8
9
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
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 - You cannot pipe objects to this function

OUTPUTS

PSCustomObject

NOTES