Posts Tagged ‘PowerShell Help’


 

HelpUri v. HelpInfoUri

Tuesday, August 16th, 2016 by June Blender
Although the names are similar and often confused, these properties are different. If you confuse them, the help for your PowerShell commands and modules won't work. The HelpUri property stores the URL (http or https) of online help for a command. It's a property of commands (cmdlets, functions, workflows). When a user runs Get-Help -Online, Get-Help opens the default browser to the HelpUri property value. The HelpInfoUri property of modules stores the URL of the online location of the HelpInfo XML file that enables updatable help for the module. In fact, a non-null value of HelpInfoUri indicates that the module…   More »

Writing Help for Dynamic Parameters

Monday, August 8th, 2016 by June Blender
Because dynamic parameters can be added to a command from multiple sources, the command author (who writes the help) cannot predict the dynamic parameters that might be available at runtime. Therefore, Get-Help expects dynamic parameters to be documented in the help file for the code that adds the dynamic parameters; not the code that has the dynamic parameters. This makes sense in theory, but, in practice, it's not discoverable and it's very confusing for users. To write help for the dynamic parameters that you add to cmdlets and functions, you need to sneak it into the description. I'll show you…   More »

Scope in a PowerShell GUI App

Wednesday, September 9th, 2015 by June Blender
If you search the SAPIEN blog, you'll realize that this is the not our first blog about scope in PowerShell GUIs. In March 2013, SAPIEN CTO Alex Riedel wrote First Rule of PowerShell Scoping Rules, a title that implies the final word in a discussion that wasn't easy to end. Alex's blog explained the differences between scoping rules in PowerShell and other languages, like VB Script. Then, just a month later, SAPIEN Senior Developer David Corrales wrote PowerShell Scoping Revisited, another great post about function scope in PowerShell. A quick search reveals even older posts by Don Jones and Jeffery…   More »

New SAPIEN Update tool integrated into all 2015 products

Monday, March 23rd, 2015 by Alex Riedel
With the release of the latest versions of the 2015 SAPIEN products we also integrated a new update tool. This new version will check for updates on all licensed and unexpired trial version of our products. It can download and install the updated versions without you going to your accounts page. If you need to roll out updates to multiple machines, you can use the “Download only” button to get the checked updates downloaded to your Windows downloads folder. You can then manually install the updates as needed. The new update tool also shows a brief synopsis of what…   More »