{"id":10631,"date":"2006-04-25T12:18:09","date_gmt":"2006-04-25T12:18:09","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/powershell\/2006\/04\/25\/ensuring-script-portability-with-requires\/"},"modified":"2019-02-18T13:24:56","modified_gmt":"2019-02-18T20:24:56","slug":"ensuring-script-portability-with-requires","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/powershell\/ensuring-script-portability-with-requires\/","title":{"rendered":"Ensuring Script Portability with #requires"},"content":{"rendered":"

With the MshSnapIn model in Beta 3, there is no gaurantee that a certain Cmdlet or Provider, apart from those in the default MshSnapIns, is available at any point. There could be a number of reasons. The MshSnapIn may not have been installed. The MshSnapIn could be removed with the remove-mshsnapin Cmdlet or not even added yet. This will cause scripts using the unavailable commands to fail or worse exhibit unpredictable behaviors. Along with the MshSnapIn model, we introduce two flavors of #requires that a script can use to express dependencies on MshSnapIns and Monad version<\/font>. The former has the following syntax:<\/font><\/p>\n

<\/p>\n

#requires -MshSnapIn SomeMshSnapIn<\/em> [-version N<\/em>[.n<\/em>]]<\/font>  where the parts in square brackets are optional. #requires must be at the beginning of a line.<\/font><\/p>\n

When only MshSnapIn is specified, the script will run if and only if the MshSnapIn SomeMshSnapIn<\/font><\/em> is already added with the Add-MshSnapIn Cmdlet (or the RunspaceConfiguration.AddMshSnapIn API). Moreover, if the major version N<\/em> is specified, the added MshSnapin’s major version must match N<\/em>. Furthermore, if the minor version n<\/em> is also specified, the added MshSnapin’s minor version must be equal to or higher than n<\/em>. Failing any of the checks will cause the script not to run. A script can have multiple #requires -MshSnapIn directives. In this case, all MshSnapIn checks will need to pass for the script to run.<\/p>\n

The latter’s syntax is as follows. <\/p>\n

#requires -version N<\/em>[.n<\/em>]<\/font>  where the parts in square brackets are optional. #requires must be at the beginning of a line.<\/font><\/p>\n

When only the major version N<\/em> is specified, the current Monad shell’s version must match N<\/em>. If the minor version is also n<\/em> specified, the current Monad shell’s minor version must be equal to or higher than n<\/em>. Failing any of the checks will cause the script not to run.<\/p>\n

Finally, for the custom shell environment, the #requires -ShellId flavor is still available. A script can have any combinations of the three #requires flavors. #requires -version will check the Monad shell version for all combinations. As for the other two flavors, here is the behavior summary:<\/p>\n\n\n\n\n\n\n
If a script has<\/td>\nMonad Shell<\/td>\nCustom Shell<\/td>\n<\/tr>\n
#requires -MshSnapIn and no #requires -ShellId<\/td>\nCheck MshSnapIn<\/td>\nScript won\u2019t run<\/td>\n<\/tr>\n
#requires -ShellId and no #requires -MshSnapIn<\/td>\nScript won\u2019t run<\/td>\nCheck ShellId<\/td>\n<\/tr>\n
#requires -ShellId and #requires -MshSnapIn<\/td>\nCheck MshSnapIn<\/td>\nCheck ShellId<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

—
Kevin Loo [MSFT]
Monad Development
Microsoft Corporation
This posting is provided “AS IS” with no warranties, and confers no rights.<\/p>\n

<\/font><\/p>\n

[Edit: Monad has now been renamed to Windows PowerShell. This script or discussion may require slight adjustments before it applies directly to newer builds.<\/i>]<\/p>\n","protected":false},"excerpt":{"rendered":"

With the MshSnapIn model in Beta 3, there is no gaurantee that a certain Cmdlet or Provider, apart from those in the default MshSnapIns, is available at any point. There could be a number of reasons. The MshSnapIn may not have been installed. The MshSnapIn could be removed with the remove-mshsnapin Cmdlet or not even added yet. This will cause scripts using the unavailable […]<\/p>\n","protected":false},"author":600,"featured_media":13641,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[],"class_list":["post-10631","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-powershell"],"acf":[],"blog_post_summary":"

With the MshSnapIn model in Beta 3, there is no gaurantee that a certain Cmdlet or Provider, apart from those in the default MshSnapIns, is available at any point. There could be a number of reasons. The MshSnapIn may not have been installed. The MshSnapIn could be removed with the remove-mshsnapin Cmdlet or not even added yet. This will cause scripts using the unavailable […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/10631","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/users\/600"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/comments?post=10631"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/10631\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media\/13641"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media?parent=10631"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/categories?post=10631"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/tags?post=10631"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}