ITTerminal::get_Name method (tapi3if.h)

The get_Name method gets a descriptive name of the terminal. The name must be usable to the user.

Syntax

HRESULT get_Name(
  [out] BSTR *ppName
);

Parameters

[out] ppName

Pointer to BSTR containing the name of the terminal.

Return value

This method can return one of these values.

Value Meaning
S_OK
Method succeeded.
E_POINTER
The ppName parameter is not a valid pointer.
E_OUTOFMEMORY
Insufficient memory exists to perform the operation.

Remarks

The application must use SysFreeString to free the memory allocated for the ppName parameter.

Requirements

Requirement Value
Target Platform Windows
Header tapi3if.h (include Tapi3.h)

See also

ITTerminal

Terminal Object

Terminal Object Interfaces