WindowsUtils.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ComputerSession</command:name> <command:verb>Get</command:verb> <command:noun>ComputerSession</command:noun> <maml:description> <maml:para>Gets sessions on local or remote computer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ComputerSession cmdlet lists all sessions on a local or remote computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ComputerSession</maml:name> <command:parameter required="false" pipelineInput="false" position="0" aliases="none"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>Computer name to list sessions.</maml:para> <maml:para>If not specified, lists sessions on local host.</maml:para> </maml:description> <dev:type>String</dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineInput="false" aliases="none"> <maml:name>ActiveOnly</maml:name> <maml:description> <maml:para>Lists only active sessions.</maml:para> </maml:description> <dev:type>SwitchParameter</dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineInput="false" aliases="none"> <maml:name>ExcludeSystemSession</maml:name> <maml:description> <maml:para>Lists only sessions with an assigned user name.</maml:para> </maml:description> <dev:type>SwitchParameter</dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-RemoteMessage</command:name> <command:verb>Invoke</command:verb> <command:noun>RemoteMessage</command:noun> <maml:description> <maml:para>Sends a message to sessions on local or remote computers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Invoke-RemoteMessage cmdlet sends a MessageBox-Style message to sessions on local or remote computers.</maml:para> <maml:para>Note: this cmdlet uses the 'WTSSendMessage' function.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-RemoteMessage</maml:name> <command:parameter required="true" position="0" pipelineInput="false" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The message box title.</maml:para> </maml:description> <dev:type>String</dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" position="1" pipelineInput="false" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>The message text.</maml:para> </maml:description> <dev:type>String</dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineInput="false" aliases="none"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name to send the nessage.</maml:para> <maml:para>If not specified, sends the message to the local host.</maml:para> </maml:description> <dev:type>String</dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineInput="false" aliases="none"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The session(s) to receive the message.</maml:para> <maml:para>If not specified, sends the message to all sessions.</maml:para> </maml:description> <dev:type>Int32[]</dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineInput="false" aliases="none"> <maml:name>Style</maml:name> <maml:description> <maml:para>A list of MessageBox style enum objects.</maml:para> <maml:para>To obtaing a list of available options, call 'Get-RemoteMessageOptions', or see definition for the MessageBox function.</maml:para> </maml:description> <dev:type>String[]</dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineInput="false" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timeout, in seconds, to wait for a response.</maml:para> <maml:para>If the timeout expires, the cmdlet returns 'Timeout'. The message is not closed.</maml:para> </maml:description> <dev:type>Int32</dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineInput="false" aliases="none"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If true, waits for the user response in the specified 'Timeout'.</maml:para> <maml:para>If false, the cmdlet returns 'AsyncReturn'.</maml:para> </maml:description> <dev:type>bool</dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineInput="false" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>If 'SessionId' is not specified, the cmdlet prompts for confirmation before sending the message to all sessions.</maml:para> <maml:para>Use the 'Force' parameter to avoid confirmation.</maml:para> </maml:description> <dev:type>SwitchParameter</dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <maml:name>Get-RemoteMessageOptions</maml:name> <maml:verb>Get</maml:verb> <maml:noun>RemoteMessageOptions</maml:noun> <maml:description> <maml:para>Lists the available style options for 'Invoke-RemoteMessage'.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet lists the available style options for the 'Invoke-RemoteMessage' cmdlet.</maml:para> <maml:para>The return object contains three properties: Name, Value and Type.</maml:para> <maml:para>'Type' is hidden by default. Use 'Format-Table', 'Format-List' or 'Select-Object' to list this property.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RemoteMessageOptions</maml:name> </command:syntaxItem> </command:syntax> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <maml:name>Send-Click</maml:name> <maml:verb>Send</maml:verb> <maml:noun>Click</maml:noun> <maml:description> <maml:para>Sends a click event.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet sends a click event to the current active desktop.</maml:para> <maml:para>It uses the function 'mouse_event'.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-Click</maml:name> </command:syntaxItem> </command:syntax> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <maml:name>Get-ResourceMessageTable</maml:name> <maml:verb>Get</maml:verb> <maml:noun>ResourceMessageTable</maml:noun> <maml:description> <maml:para>Gets the message table information from a message table file or DLL.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet gets the message table information from a message table file or DLL.</maml:para> <maml:para>It retrieves MessageId and Message.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ResourceMessageTable</maml:name> <command:parameter required="true" position="0" pipelineInput="true" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The file path.</maml:para> </maml:description> <dev:type>String</dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:examples> <command:example> <maml:title>########### ~ Get message table from 'kernel32.dll ~ ##########</maml:title> <dev:code>PS Get-ResourceMessageTable -Path "$env:SystemRoot\System32\kernel32.dll"</dev:code> <dev:remarks> <maml:para>This command gets the message table from kernel32.dll by explicitly passing it's path.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>########### ~ Get message table from 'kernel32.dll using the pipeline ~ ##########</maml:title> <dev:code>PS Get-ChildItem -Path "$env:SystemRoot\System32\kernel32.dll" | Get-ResourceMessageTable</dev:code> <dev:remarks> <maml:para>This command gets the message table from kernel32.dll by passing it's object throught the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <maml:name>Get-FormattedError</maml:name> <maml:verb>Get</maml:verb> <maml:noun>FormattedError</maml:noun> <maml:description> <maml:para>Gets the error message for a specific error.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet gets the formatted error message for a provided valid error id.</maml:para> <maml:para>It uses the function 'FormatMessage'.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FormattedError</maml:name> <command:parameter required="true" position="0" pipelineInput="true" aliases="none"> <maml:name>ErrorCode</maml:name> <maml:description> <maml:para>The error code.</maml:para> </maml:description> <dev:type>Int32</dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:examples> <command:example> <maml:title>####### ~ Get error message by providing the error code ~ #####</maml:title> <dev:code>PS Get-FormattedError -ErrorCode 5</dev:code> <dev:remarks> <maml:para>This command gets the error message for the provided error code.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>###### ~ Get error message from GetLastWin32Error method ~ ####</maml:title> <dev:code>PS [System.Runtime.InteropServices.Marshal]::GetLastWin32Error() | Get-FormattedError</dev:code> <dev:remarks> <maml:para>This command gets the error message from the System.Runtime.InteropServices.Marshal.GetLastWin32Error() method.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <maml:name>Get-LastWin32Error</maml:name> <maml:verb>Get</maml:verb> <maml:noun>LastWin32Error</maml:noun> <maml:description> <maml:para>Gets the error message for the last Win32 error.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet gets the formatted error message for the last Win32 error thrown by the system.</maml:para> <maml:para>It uses the function 'FormatMessage'.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LastWin32Error</maml:name> </command:syntaxItem> </command:syntax> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <maml:name>Get-LastWinSockError</maml:name> <maml:verb>Get</maml:verb> <maml:noun>LastWinSockError</maml:noun> <maml:description> <maml:para>Gets the error message for the last WinSock error.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet gets the formatted error message for the last WinSock error thrown by the system.</maml:para> <maml:para>It uses the function 'FormatMessage'.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LastWinSockError</maml:name> </command:syntaxItem> </command:syntax> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <maml:name>Get-FileHandle</maml:name> <maml:verb>Get</maml:verb> <maml:noun>FileHandle</maml:noun> <maml:description> <maml:para>Gets the processes using the file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet gets the processes with a valid handle to the file.</maml:para> <maml:para>Designed to be a PowerShell-Native implementation of the SysInternal's tool 'handle.exe'.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FileHandle</maml:name> <command:parameter required="true" position="0" pipelineInput="true" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The file path.</maml:para> </maml:description> <dev:type>String</dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <maml:name>Get-MsiProperties</maml:name> <maml:verb>Get</maml:verb> <maml:noun>MsiProperties</maml:noun> <maml:description> <maml:para>Gets the property table from a MSI file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet gets the property table information from a MSI file.</maml:para> <maml:para>It uses msi.h and msiquery.h.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MsiProperties</maml:name> <command:parameter required="true" position="0" pipelineInput="true" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The file path.</maml:para> </maml:description> <dev:type>String</dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> </command:command> </helpItems> |