IPrintDialogServices::GetCurrentPortName

[This is preliminary documentation and subject to change.]

An application using the PrintDlgEx function can call the GetCurrentPortName method to retrieve the name of the current port.

HRESULT GetCurrentPortName(
  LPTSTR lpPortName,
  UINT *pcchSize
);
 

Parameters

lpPortName

Pointer to a buffer that receives the null-terminated name of the current port.

pcchSize

Pointer to a UINT variable. On input, the variable specifies the size, in bytes (ANSI version) or 16-bit characters (Unicode version), of the buffer pointed to by the lpPortName parameter. On output, the variable contains the number of bytes or characters, including the terminating null character, written to the buffer.

If the size is zero on input, the function returns the required buffer size (in bytes or characters) in pcchSize and does not use the lpPortName buffer.

Return Values

If the method is successful, the return value is S_OK. If there is no current port, the return value is S_OK, the value returned in pcchSize is zero, and the lpPortName buffer is unchanged.

If an error occurs, the return value is a COM error code. For more information, see Error Handling.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in commdlg.h.

See Also

Common Dialog Box Library Overview, IPrintDialogServices, PrintDlgEx