OutPrinterCommand.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DefaultPrinter</command:name> <command:verb>Get</command:verb> <command:noun>DefaultPrinter</command:noun> <maml:description> <maml:para>Returns an object reflecting the default printer on the the local computer</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The PrintManagement CIM module included with PowerShell does not provide a way to discover the default printer. This command adds one, returning an object which can be piped into, for example, the Get-PrintConfiguration Command from PrintManagement. Note that Print ManagementProvides formatting for MSFT_Printer CIM objects, which this command returns. Its output will be displayed differently depending on whether that module is loaded or not.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DefaultPrinter</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_Printer</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> (Get-DefaultPrinter).Name</dev:code> <dev:remarks> <maml:para>Displays just the name of the default printer.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-DefaultPrinter | Get-PrintConfiguration</dev:code> <dev:remarks> <maml:para>Gets the default printer, and returns its configuration.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-DefaultPrinter | Set-PrintConfiguration -PaperSize Letter</dev:code> <dev:remarks> <maml:para>Gets the default printer, and sets the paper size to US Letter. Note that changing the printer configuration requires elevated permissions.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Out-Printer</command:name> <command:verb>Out</command:verb> <command:noun>Printer</command:noun> <maml:description> <maml:para>Sends output to a printer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Out-Printer sends output to the default printer or to an alternate printer, if one is specified. Font, paper-orientation, paper-size, and margins can all be set, and page numbers can be requested. Content can be piped into the command, optionally using its alias 'lp' to give a Unix like | lp, or it can take the path to a text or image file as a parameter. If objects are piped into the command, it attempts to apply default formatting. When using Print to PDF or similar output-to-file printers, the file name can be specified, and if it is, the file can be opened in its default viewer. There is an option to add page numbers which are positioned at the top of text pages (not image ones), if there is not sufficient border for the page number, the top of the printing area is moved down to avoid overlap. When setting margins, be aware that Windows specifies paper dimensions in hundredths of an inch font sizes are in points - 1pt = 1/120th inch -so inch-based makes more sense here than in other places. If you are working in mm, multiplying by 4 converts to hundredths accurately enough for most margins. (For absolute accuracy divide by 0.254)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-Printer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>The content to be sent to the printer. This can be objects to print, or the target for piped objects.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Name"> <maml:name>PrinterName</maml:name> <maml:Description> <maml:para>Name of printer - can specify either -Printer or -Name. If not specified, the default printer will be used.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>PaperSize</maml:name> <maml:Description> <maml:para>Name of a paper-size on the selected printer (e.g A4, Letter). Some printers have been observed to have issues setting the size.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="Font"> <maml:name>FontName</maml:name> <maml:Description> <maml:para>Typeface to use, e.g. Consolas, "Courier New" (defaults to "Lucida Console"). Non-proportionally spaced fonts will often work better, but no check is done to prevent the use of Comic Sans.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="Size"> <maml:name>FontSize</maml:name> <maml:Description> <maml:para>Size of font, defaults to 10 point.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="PrintFileName"> <maml:name>Destination</maml:name> <maml:Description> <maml:para>Specifies the name of a file to print to so that Print to PDF and similar drivers do not require user input. If the file already exists it will be overwritten.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BottomMargin</maml:name> <maml:Description> <maml:para>Bottom Margin in units of 1/100th inch. Zero will be converted to the minimum margin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LandScape</maml:name> <maml:Description> <maml:para>By default printing will be in portrait orientation, unless -Landscape is specified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LeftMargin</maml:name> <maml:Description> <maml:para>Left Margin in units of 1/100th inch. Zero will be converted to the minimum margin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoImageScale</maml:name> <maml:Description> <maml:para>Disable scaling of images - by default images ARE scaled to fill the page.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Show"> <maml:name>OpenDestinationFile</maml:name> <maml:Description> <maml:para>If specified, the print is opened file after printing. If the destination file is not specified, this value is ignored.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RightMargin</maml:name> <maml:Description> <maml:para>Right Margin in units of 1/100th inch. Zero will be converted to the minimum margin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TopMargin</maml:name> <maml:Description> <maml:para>Top Margin in units of 1/100th inch. Zero will be converted to the minimum margin</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Footer</maml:name> <maml:Description> <maml:para>If specified page a footer will be added at the bottom of text pages. Supports &[Page] &[Date] &[Time] &[Path] &[Line] &[HistoryId], to insert the page number, print date/time, file path (if applicable), PowerShell command line, and PowerShell HistoryId.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Header</maml:name> <maml:Description> <maml:para>If specified page a Header will be added at the top of text pages. Supports &[Page] &[Date] &[Time] &[Path] &[Line] &[HistoryId], to insert the page number, print date/time, file path (if applicable), PowerShell command line, and PowerShell HistoryId.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="NoWrapText"> <maml:name>NoTextWrapping</maml:name> <maml:Description> <maml:para>By default, the command assumes the font is non-proportional and calculates how many characters fit into the page width and attempts to wrap text at that number. This switch prevents word-wrapping, for example text has been pre-formatted.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Out-Printer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="FileName"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Path of text file to be printed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Name"> <maml:name>PrinterName</maml:name> <maml:Description> <maml:para>Name of printer - can specify either -Printer or -Name. If not specified, the default printer will be used.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>PaperSize</maml:name> <maml:Description> <maml:para>Name of a paper-size on the selected printer (e.g A4, Letter). Some printers have been observed to have issues setting the size.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="Font"> <maml:name>FontName</maml:name> <maml:Description> <maml:para>Typeface to use, e.g. Consolas, "Courier New" (defaults to "Lucida Console"). Non-proportionally spaced fonts will often work better, but no check is done to prevent the use of Comic Sans.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="Size"> <maml:name>FontSize</maml:name> <maml:Description> <maml:para>Size of font, defaults to 10 point.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="PrintFileName"> <maml:name>Destination</maml:name> <maml:Description> <maml:para>Specifies the name of a file to print to so that Print to PDF and similar drivers do not require user input. If the file already exists it will be overwritten.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BottomMargin</maml:name> <maml:Description> <maml:para>Bottom Margin in units of 1/100th inch. Zero will be converted to the minimum margin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LandScape</maml:name> <maml:Description> <maml:para>By default printing will be in portrait orientation, unless -Landscape is specified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LeftMargin</maml:name> <maml:Description> <maml:para>Left Margin in units of 1/100th inch. Zero will be converted to the minimum margin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoImageScale</maml:name> <maml:Description> <maml:para>Disable scaling of images - by default images ARE scaled to fill the page.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Show"> <maml:name>OpenDestinationFile</maml:name> <maml:Description> <maml:para>If specified, the print is opened file after printing. If the destination file is not specified, this value is ignored.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RightMargin</maml:name> <maml:Description> <maml:para>Right Margin in units of 1/100th inch. Zero will be converted to the minimum margin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TopMargin</maml:name> <maml:Description> <maml:para>Top Margin in units of 1/100th inch. Zero will be converted to the minimum margin</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Footer</maml:name> <maml:Description> <maml:para>If specified page a footer will be added at the bottom of text pages. Supports &[Page] &[Date] &[Time] &[Path] &[Line] &[HistoryId], to insert the page number, print date/time, file path (if applicable), PowerShell command line, and PowerShell HistoryId.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Header</maml:name> <maml:Description> <maml:para>If specified page a Header will be added at the top of text pages. Supports &[Page] &[Date] &[Time] &[Path] &[Line] &[HistoryId], to insert the page number, print date/time, file path (if applicable), PowerShell command line, and PowerShell HistoryId.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="NoWrapText"> <maml:name>NoTextWrapping</maml:name> <maml:Description> <maml:para>By default, the command assumes the font is non-proportional and calculates how many characters fit into the page width and attempts to wrap text at that number. This switch prevents word-wrapping, for example text has been pre-formatted.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Out-Printer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ImagePath</maml:name> <maml:Description> <maml:para>Path to a BMP, GIF, JPEG, PNG or TIFF file to be printed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Name"> <maml:name>PrinterName</maml:name> <maml:Description> <maml:para>Name of printer - can specify either -Printer or -Name. If not specified, the default printer will be used.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>PaperSize</maml:name> <maml:Description> <maml:para>Name of a paper-size on the selected printer (e.g A4, Letter). Some printers have been observed to have issues setting the size.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="PrintFileName"> <maml:name>Destination</maml:name> <maml:Description> <maml:para>Specifies the name of a file to print to so that Print to PDF and similar drivers do not require user input. If the file already exists it will be overwritten.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BottomMargin</maml:name> <maml:Description> <maml:para>Bottom Margin in units of 1/100th inch. Zero will be converted to the minimum margin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LandScape</maml:name> <maml:Description> <maml:para>By default printing will be in portrait orientation, unless -Landscape is specified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LeftMargin</maml:name> <maml:Description> <maml:para>Left Margin in units of 1/100th inch. Zero will be converted to the minimum margin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoImageScale</maml:name> <maml:Description> <maml:para>Disable scaling of images - by default images ARE scaled to fill the page.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Show"> <maml:name>OpenDestinationFile</maml:name> <maml:Description> <maml:para>If specified, the print is opened file after printing. If the destination file is not specified, this value is ignored.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RightMargin</maml:name> <maml:Description> <maml:para>Right Margin in units of 1/100th inch. Zero will be converted to the minimum margin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TopMargin</maml:name> <maml:Description> <maml:para>Top Margin in units of 1/100th inch. Zero will be converted to the minimum margin</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BottomMargin</maml:name> <maml:Description> <maml:para>Bottom Margin in units of 1/100th inch. Zero will be converted to the minimum margin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="PrintFileName"> <maml:name>Destination</maml:name> <maml:Description> <maml:para>Specifies the name of a file to print to so that Print to PDF and similar drivers do not require user input. If the file already exists it will be overwritten.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="Font"> <maml:name>FontName</maml:name> <maml:Description> <maml:para>Typeface to use, e.g. Consolas, "Courier New" (defaults to "Lucida Console"). Non-proportionally spaced fonts will often work better, but no check is done to prevent the use of Comic Sans.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="Size"> <maml:name>FontSize</maml:name> <maml:Description> <maml:para>Size of font, defaults to 10 point.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ImagePath</maml:name> <maml:Description> <maml:para>Path to a BMP, GIF, JPEG, PNG or TIFF file to be printed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>The content to be sent to the printer. This can be objects to print, or the target for piped objects.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LandScape</maml:name> <maml:Description> <maml:para>By default printing will be in portrait orientation, unless -Landscape is specified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LeftMargin</maml:name> <maml:Description> <maml:para>Left Margin in units of 1/100th inch. Zero will be converted to the minimum margin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoImageScale</maml:name> <maml:Description> <maml:para>Disable scaling of images - by default images ARE scaled to fill the page.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Show"> <maml:name>OpenDestinationFile</maml:name> <maml:Description> <maml:para>If specified, the print is opened file after printing. If the destination file is not specified, this value is ignored.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>PaperSize</maml:name> <maml:Description> <maml:para>Name of a paper-size on the selected printer (e.g A4, Letter). Some printers have been observed to have issues setting the size.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="FileName"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Path of text file to be printed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Name"> <maml:name>PrinterName</maml:name> <maml:Description> <maml:para>Name of printer - can specify either -Printer or -Name. If not specified, the default printer will be used.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RightMargin</maml:name> <maml:Description> <maml:para>Right Margin in units of 1/100th inch. Zero will be converted to the minimum margin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TopMargin</maml:name> <maml:Description> <maml:para>Top Margin in units of 1/100th inch. Zero will be converted to the minimum margin</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Footer</maml:name> <maml:Description> <maml:para>If specified page a footer will be added at the bottom of text pages. Supports &[Page] &[Date] &[Time] &[Path] &[Line] &[HistoryId], to insert the page number, print date/time, file path (if applicable), PowerShell command line, and PowerShell HistoryId.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Header</maml:name> <maml:Description> <maml:para>If specified page a Header will be added at the top of text pages. Supports &[Page] &[Date] &[Time] &[Path] &[Line] &[HistoryId], to insert the page number, print date/time, file path (if applicable), PowerShell command line, and PowerShell HistoryId.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="NoWrapText"> <maml:name>NoTextWrapping</maml:name> <maml:Description> <maml:para>By default, the command assumes the font is non-proportional and calculates how many characters fit into the page width and attempts to wrap text at that number. This switch prevents word-wrapping, for example text has been pre-formatted.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-Help Out-Printer | Out-Printer</dev:code> <dev:remarks> <maml:para>Sends this help to the default printer using the default settings.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> dir | Out-Printer -PrinterName 'Microsoft Print to PDF' -PrintFileName .\files.pdf -LeftMargin 50 -Verbose</dev:code> <dev:remarks> <maml:para>Sends a directory listing to the 'Microsoft Print to PDF' printer. If the file name is not specified, a dialog will appear, but in this case "files.pdf" is passed from the command line. The print will a have left margin of 0.50 inches, using the default paper-size in portrait format, with the default typeface and font size. Verbose output will show the printer name, file name, and paper size. </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Out-Printer -Verbose -ImagePath .\lewis.jpg -LandScape</dev:code> <dev:remarks> <maml:para>Sends a picture to the default printer, printing in Landscape mode. Specifying -Verbose will give information on the scaling applied.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-Service | ft -a | Out-Printer -Name 'Send To OneNote 2016' -LeftMargin 0 -RightMargin 0 -TopMargin 50 -FontSize 8 -PaperSize 'A3'</dev:code> <dev:remarks> <maml:para>This time services are formatted as an auto-sized table, and sent to OneNote. The page margins are customized and font reduced to fit on the page. </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS C:\> Out-Printer -Path .\6Print.psd1 -PrinterName 'Microsoft Print to PDF' -Destination .\listing.pdf -Landscape -PaperSize a3 -FontName 'Calibri' -FontSize 9</dev:code> <dev:remarks> <maml:para>Sends a text file to the 'Microsoft Print to PDF' printer, creating a file named "listing.pdf". Here the printing is rotated to LandScape and the page is size to A3. The font uses the Calibri typeface set in 9 point size. </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>PS C:\> dir | lp -Dest ~\Desktop\test3.pdf -Font 'Comic Sans MS' -Size 8 -top 0 -bottom 0 -left 0 -right 0 -Head "Page &[Page]" -Open</dev:code> <dev:remarks> <maml:para>This Example adds page numbers, but also uses the alias lp ; FontName can be shortened to Font, FontSize to size and "margin" omitted from each of the four margin parameters. The Header and OpenDestinationFile parameters can also be shortened. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Github</maml:linkText> <maml:uri>https://github.com/jhoneill/6Print</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-DefaultPrinter</command:name> <command:verb>Set</command:verb> <command:noun>DefaultPrinter</command:noun> <maml:description> <maml:para>Sets the default printer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The PrintManagement CIM module included with PowerShell does not provide a way to set the default printer. This command adds one, and if -PassThru is specified, the selected printer is returned as a CIM object which can be used with the commands in the PrintManagement module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DefaultPrinter</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Name"> <maml:name>Printer</maml:name> <maml:Description> <maml:para>A printer name or object. If this is a string, it must exactly match one of the printer names returned by Get-Printer. Wildcards are NOT supported. If it is an object, it must have a Name or PrinterName property which matches.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Show"> <maml:name>Passthru</maml:name> <maml:Description> <maml:para>If specified, an object representing the selected printer will be returned, otherwise the command runs silently.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Name"> <maml:name>Printer</maml:name> <maml:Description> <maml:para>A printer name or object. If this is a string, it must exactly match one of the printer names returned by Get-Printer. Wildcards are NOT supported. If it is an object, it must have a Name or PrinterName property which matches.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Show"> <maml:name>Passthru</maml:name> <maml:Description> <maml:para>If specified, an object representing the selected printer will be returned, otherwise the command runs silently.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_Printer</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-DefaultPrinter 'Brother HL-1110 series' -Passthru | Set-PrintConfiguration -PaperSize A4</dev:code> <dev:remarks> <maml:para>Sets the default printer, and then sets its paper size to DIN A4. Note that changing the printer configuration requires elevated permissions.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-Printer *PDF | Set-DefaultPrinter</dev:code> <dev:remarks> <maml:para>Finds the "Microsoft Print To PDF" printer and makes it the default printer. </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> get-printer | where {$_.drivername -notmatch "microsoft" -AND (Get-PrintConfiguration $_).color} | Set-DefaultPrinter</dev:code> <dev:remarks> <maml:para>Finds a color printer excluding the Onenote, PDF and XPS drivers which have "Microsoft" in their names, printer and Makes it the default printer. (If more than one driver matches these criteria the last one "wins". ) </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |