SplDeletePort: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 9: | Line 9: | ||
;pszComputerName (PSZ) - input: Name of computer where port is to be removed. | ;pszComputerName (PSZ) - input: Name of computer where port is to be removed. | ||
:A NULL string identifies the local workstation. This currently must be NULL. | :A NULL string identifies the local workstation. This currently must be NULL. | ||
;pszPortName (PSZ) - input: Name of printer port to remove. | ;pszPortName (PSZ) - input: Name of printer port to remove. | ||
: This can be a virtual port name. Following is an example of a port name:<tt>LPT5</tt> | : This can be a virtual port name. Following is an example of a port name:<tt>LPT5</tt> | ||
:;Note:This port cannot be removed if it is referenced by a print device. | :;Note:This port cannot be removed if it is referenced by a print device. | ||
Latest revision as of 12:42, 2 July 2023
This function is called to remove a printer port.
- Note
- There is currently no support for using this API to remotely remove a printer port.
Syntax
SplDeletePort(pszComputerName, pszPortName)
Parameters
- pszComputerName (PSZ) - input
- Name of computer where port is to be removed.
- A NULL string identifies the local workstation. This currently must be NULL.
- pszPortName (PSZ) - input
- Name of printer port to remove.
- This can be a virtual port name. Following is an example of a port name:LPT5
- Note
- This port cannot be removed if it is referenced by a print device.
- rc (ULONG) - returns
- Return codes.
- 0 Success
- 50 ERROR_NOT_SUPPORTED - pszComputerName is not supported.
- 87 ERROR_INVALID_PARAMETER - An invalid buffer was given.
- 99 ERROR_DEVICE_IN_USE - Port name is connected to a print queue.