Platform SDK: TAPI

ITDirectoryObjectUser::put_IPPhonePrimary

This method sets the name of a machine as the primary IP phone for a user.

HRESULT put_IPPhonePrimary(
  BSTR pName
);

Parameters

pName
[in] Pointer to BSTR representation of user's IP primary phone.

Return Values

Value Meaning
S_OK Method succeeded.
E_POINTER Invalid pointer.

Remarks

This method can only be used on a new object which is subsequently added to the directory. If an application wants to modify the IP phone of an existing user object, it has to enumerate the objects from the server to determine the old IP phones are. This implies that a TAPI 3.0 application is running on one or more other machines. The application on a local machine has no information about whether those other applications are still running. Therefore, it is not the application's place to change the IP Phone on existing user objects.

To modify an existing user's IP Phone, the user must be deleted and re-added.

The application must use SysAllocString to allocate memory for the pName parameter and use SysFreeString to free the memory when the variable is no longer needed.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Version: Requires TAPI 3.0 or later.
  Header: Declared in Rend.h.
  Library: Use Rendid.lib.

See Also

ITDirectoryObjectUser, ITDirectoryObjectUser::get_IPPhonePrimary