IH323LineEx::SetAlias method

[SetAlias is not available for use in Windows Vista, Windows Server 2008, and subsequent versions of the operating system. The RTC Client API provides similar functionality.]

The SetAlias method configures a default H.323 alias for the address. This alias will be used in the H.323 call setup exchange so that the other party knows the name of this party.

Calling this method a second time will overwrite the previous alias.

The alias set on this interface will be used only when there is no other way for the TSP to find a proper alias. In the future, when gatekeeper support is added into the TSP, the alias registered to the gatekeeper or assigned by the gatekeeper will override whatever is set through this method.

Syntax

HRESULT SetAlias(
  [in] WCHAR *strAlias,
  [in] DWORD dwLength
);

Parameters

strAlias [in]

The alias to be used, in Unicode. Null termination is not required.

dwLength [in]

The length of the alias name in number of characters, including the null terminator.

Return value

This method can return one of these values.

Return code Description
S_OK
Method succeeded.
E_POINTER
The number of characters indicated in dwLength exceeds the actual number of characters in the strAlias parameter.

Requirements

Requirement Value
TAPI version
Requires TAPI 3.0 or later
Header
H323priv.h
Library
Uuid.lib
DLL
Tapi3.dll