Object/Object.ps1

#region Copyright & License

# Copyright © 2012 - 2022 François Chabot
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

#endregion

Set-StrictMode -Version Latest

<#
.SYNOPSIS
   Use and dispose of an object that supports IDisposable.
.DESCRIPTION
   Like the C# using statement, dispose an object after usage that supports IDisposable.
.PARAMETER Object
   The object to use and to be disposed of afterwards.
.PARAMETER Process
   The script block that exercises the object to be disposed of afterwards.
.EXAMPLE
   Using-Object ($streamWriter = New-Object System.IO.StreamWriter("some-file.txt")) {
      $streamWriter.WriteLine('some content.')
   }
.NOTES
   Notice that, unlike in its original source mentioned below, the function is called 'Use-Object', which does
   rely on an approved PowerShell verb, and not 'Using-Object', which does not. See
   https://davewyatt.wordpress.com/2014/04/11/using-object-powershell-version-of-cs-using-statement/
#>

function Use-Object {
   [CmdletBinding()]
   [OutputType([void])]
   param (
      [Parameter(Mandatory = $true)]
      [AllowEmptyString()]
      [AllowEmptyCollection()]
      [AllowNull()]
      [System.IDisposable]
      $Object,

      [Parameter(Mandatory = $true)]
      [scriptblock]
      $Process
   )
   Resolve-ActionPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState
   try {
      . $Process
   } finally {
      if ($null -ne $Object) {
         $Object.Dispose()
      }
   }
}

# SIG # Begin signature block
# MIII0QYJKoZIhvcNAQcCoIIIwjCCCL4CAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUQ5rr9Q6n2PBlRFucb7ANittC
# AnCgggVMMIIFSDCCAzCgAwIBAgIJAJkr3mJdTBkUMA0GCSqGSIb3DQEBCwUAMEEx
# PzA9BgNVBAMeNgBpAGMAcgBhAGYAdABzAG8AZgB0AHcAYQByAGUAQABzAHQAYQB0
# AGUAbABlAHMAcwAuAGIAZTAeFw0yMTA2MjUxNDEyMjNaFw00MTA2MjAxNDEyMjNa
# MEExPzA9BgNVBAMeNgBpAGMAcgBhAGYAdABzAG8AZgB0AHcAYQByAGUAQABzAHQA
# YQB0AGUAbABlAHMAcwAuAGIAZTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoC
# ggIBAOeqdUHBv7sxSeX3aj6yPKj7PAvs8izpVXjyEBl5aR8mQneVcXuF53AH7EW1
# 6E5p4+Az5pJPGUD5c3tXhiGMF7vgLhQjO6hlaVBRIqiIYHikNLwMNy6YBMc/QQYM
# rPhqHEFsZ53dkBIIj3M8e3kFcTFA09n25yDtTPDab4nd9yUhc9Qc8+nfpIzfYsoP
# 1pZ3nCzhw6hN2/44v1dkQrG3dRYwt+px65p6NPNZWEJpt4VCJjIFh+lBYJdxm9d4
# X/rAnlHIkbv7liOavWDzgHVabS3hdAWtcDmynm+7+FcZDFqPWNCl3e4SS7xe4s/R
# CKFKA0IsfKkSk9YJlLgeSQIEXUOOWXJAGaLqnRD8xWLZsc4Oi9GZg7XV1mv/S88c
# oztXnwtAN3OOlRKBh2QbomMgxeMO0GvsLE/cq5Q/YKAoz+KGr/7LcZq9jzQ8IPus
# ZvWLeDXmxPiwJjpZc1koLgfGIEX2NStQTT3QmacWr9thrWcKvI+4uBmI4exS9B4a
# R3nV91w5EY+2RoYsHqej9LWwNamO96+jMX9pxprTX+EkLUuMAikw/po8sBC9MUUn
# 5pMWmUv7DCtQOLGGBDDMMMkn4ZcjpCEEdPGHRKfqNnD27ssGtDjiNzfQrsm67toU
# bBwUF+gyJq/YckWquYJhA9ZOFWEADuIwGnsOzsoRvuQyY+p9AgMBAAGjQzBBMA4G
# A1UdDwEB/wQEAwIHgDAWBgNVHSUBAf8EDDAKBggrBgEFBQcDAzAXBgNVHREEEDAO
# ggxzdGF0ZWxlc3MuYmUwDQYJKoZIhvcNAQELBQADggIBACithYM3qckZRc9+Xbfu
# a6gWr3HwjrW+FHKgjfrcOm8ZnLVapb9xFqsqrRQqd3RXWQDINEGrtI2rSfrzyfoK
# UiTgldIfQNP1ZcGY229d++90t3hdo2mlt05hjYlbMENloJHpsEP0vQZmwOcEimCT
# ex1pymYM+P9pj3j8UD1PT1eIZot6or8fBRl63UybyDSrM7L4UOkkAOniKxWy5pW6
# 6duS8SR+SZpr3Bv44NyXPj0Nv+MIpLmsLrd7XPBFmnGxzY01ZO9vzi9KEhM2wT5i
# jPqHDNOvfPiADtAa+EyUBzdJiqy9heCz/TMZQgMWGwtfqJNxWZmsHcha2anW4Qt+
# mzrLO4GojWoVog9uVSAq+l0a+YQsd1u1kUmm4vgZCFyUA+lEp4LkI7ca2VBHkLPD
# w+u2DoDMRiqFPZjO7BCKjGc0jj9B/qGR3JVt+tqDdB621xXf2YGF2oFvxZQ/keGt
# 0ujfJ+JwN3nCulDAA4773q6KUnfykyrvAgITNbRJL6TngeRKtw9VIJBPxzqMzLpV
# 5ggXNituwLaD1CCBJ1oo9DZHpL9gplXp1wGrelJOTiJhh+pdNsPtRH7CrranWa5h
# LFLuigqin0eewQ5giJ1VaiBVEseOmiZog+27UpFIv40aDzgGL3YxB/Mu0ojwrQtp
# WLmqJCmWnR5qxOm0yK+zNWe0MYIC7zCCAusCAQEwTjBBMT8wPQYDVQQDHjYAaQBj
# AHIAYQBmAHQAcwBvAGYAdAB3AGEAcgBlAEAAcwB0AGEAdABlAGwAZQBzAHMALgBi
# AGUCCQCZK95iXUwZFDAJBgUrDgMCGgUAoHgwGAYKKwYBBAGCNwIBDDEKMAigAoAA
# oQKAADAZBgkqhkiG9w0BCQMxDAYKKwYBBAGCNwIBBDAcBgorBgEEAYI3AgELMQ4w
# DAYKKwYBBAGCNwIBFTAjBgkqhkiG9w0BCQQxFgQUTszggzIz+1F+r68S7aR06s62
# Fe4wDQYJKoZIhvcNAQEBBQAEggIA4fvjqmg/nKhhCiS2/wv4qpXkLnClcRDLuduf
# 5uenxhhWJcpbXWXk+MhjPhDFbwiB5UzIxxo9nxWPEgaUxtI+UMKEGZAu6UYl54+U
# tIh4+cdeYYRtJ4mAdDNQLq93FbgWWTfyNb1zbvYWzfr1YBHn3yIe5bs/TPaDRLyS
# GpuKcKWxz8Tj1d7CTQq+pg+4vQvCnjRnAKlvF5o0JZ1OAFcu4Hcdp3NBPP7OpcU3
# WjI8ZrL8KyFeE60iS8qNLJlJ9iBItM6tCKf44KKMc9wJI7AgYmYQf6eh69caR3FF
# JyNeRNsnFo4Uzx1d/szI8KN7OB12x2RjvTyBO2aNzRnY1VHoKx95yvy79Yn7xXcl
# u39JOysgh9E5K5tWQ6gkUxRPOZF4rYvoI7Ou/VDoxDZbkQOFISn5JKrIRgIMW3Vs
# oHZO47mQ/L2PYitHgts+RYDl8OOt5aukzgf7l3HOwKuwIaEjOWXw4eJQQcu4Ums9
# ryXJ7lIRZ0Hqqidlg8j/ZK+qHgmMhxEgTPAmHucO3TUTj5h/d1Zoj2bPrw7EfyDr
# Hdz/sOqgKd5iF3F/H4rHOPtWlADUKaTf4nTd8xnJB8jawyy6gAQZP0rv9Ri2UbSE
# 2tnVylS2KEDa1QiYK+wnRmqwTFsHLQgkE6p0qu4PWIGrnm2w4+ecdpdYZhqqabm4
# fggMsp0=
# SIG # End signature block