AddPrinterConnection - powershell.one

Adds a connection to the printer.

Example

Do not run below example code just to see what happens next. Many methods seriously affect your system. Always make sure you actually understand what the method and the code do.

# define the arguments you want to submit to the method
# remove values that you do not want to submit
# make sure you replace values with meaningful content before running the code
# see section "Parameters" below for a description of each argument.
$arguments = @{
    Name            = 'someText'  # replace 'someText' with meaningful text
}


Invoke-CimMethod -ClassName Win32_Printer -Namespace Root/CIMV2 -MethodName AddPrinterConnection -Arguments $arguments |
Add-Member -MemberType ScriptProperty -Name ReturnValueFriendly -Passthru -Value {
  switch ([int]$this.ReturnValue)
  {
        0        {'Success'}
        5        {'Access denied'}
        1801     {'Invalid printer name'}
        1930     {'The printer driver is not compatible with a policy enabled on your computer that blocks NT 4.0 drivers'}
        default  {'Unknown Error '}
    }
}

To run this method on one or more remote systems, use New-CimSession:

$ComputerName = 'server12','server14'  # adjust to your server names
$Credential   = Get-Credential         # submit a user account with proper permissions

# define the arguments you want to submit to the method
# remove values that you do not want to submit
# make sure you replace values with meaningful content before running the code
# see section "Parameters" below for a description of each argument.
$arguments = @{
    Name            = 'someText'  # replace 'someText' with meaningful text
}


$session = New-CimSession -ComputerName $ComputerName -Credential $Credential

Invoke-CimMethod -ClassName Win32_Printer -Namespace Root/CIMV2 -MethodName AddPrinterConnection -Arguments $arguments -CimSession $session |
Add-Member -MemberType ScriptProperty -Name ReturnValueFriendly -Passthru -Value {
  switch ([int]$this.ReturnValue)
  {
        0        {'Success'}
        5        {'Access denied'}
        1801     {'Invalid printer name'}
        1930     {'The printer driver is not compatible with a policy enabled on your computer that blocks NT 4.0 drivers'}
        default  {'Unknown Error '}
    }
}


Remove-CimSession -CimSession $session

Learn more about Invoke-CimMethod and invoking WMI methods.

Syntax

uint32 AddPrinterConnection(
  [in] string Name
);

Parameters

Name	Type	Description
Name	String	The Name parameter specifies a friendly name for the printer. This may be overridden if the name has alreadybeen set by the printer.

Return Value

Returns a value of type UInt32. Return values:

$returnValues = @{
    0    = 'Success'
    5    = 'Access denied'
    1801 = 'Invalid printer name'
    1930 = 'The printer driver is not compatible with a policy enabled on your computer that blocks NT 4.0 drivers'
}

Requirements

To use Win32_Printer, the following requirements apply:

PowerShell

Get-CimInstance was introduced with PowerShell Version 3.0, which in turn was introduced on clients with Windows 8 and on servers with Windows Server 2012.

If necessary, update Windows PowerShell to Windows PowerShell 5.1, or install PowerShell 7 side-by-side.

Operating System

Win32_Printer was introduced on clients with WindowsÂ Vista and on servers with Windows ServerÂ 2008.

Namespace

Win32_Printer lives in the Namespace Root/CIMV2. This is the default namespace. There is no need to use the -Namespace parameter in Get-CimInstance.

Implementation

Win32_Printer is implemented in CIMWin32.dll and defined in Win32_Printer.mof. Both files are located in the folder C:\Windows\system32\wbem:

explorer $env:windir\system32\wbem
notepad $env:windir\system32\wbem\Win32_Printer.mof

PREVIOUSArchive