QueryHomeServer

Applies to: Lync 2013 | Lync Server 2013

QueryHomeServer

The QueryHomeServer function returns the fully qualified domain name (FQDN) of the home server for a specified SIP user.

Syntax

string QueryHomeServer(
  string userAtHost,
  bool isPhone,
  ClusterType clusterType
);

Parameters

  • userAtHost
    A SIP user as a string of the form "someone@example.com" whose home server will be returned.

  • isPhone
    An optional Boolean flag indicating if the userAtHost parameter specifies a URI of a phone (true) or not (false). This parameter must be set if the clusterType parameter is specified.

  • clusterType
    An optional parameter specifying the type of a cluster being queried. The possible value is ClusterType.PrimaryRegistrar, ClusterType.BackupRegistratr or ClusterType.UserServices. If this is present, the isPhone parameter must be set as well.

Return Values

Returns the FQDN of the Standard Edition home server or Enterprise Edition pool corresponding to the type of cluster queried. If clusterType is not specified, ClusterType.UserServices is the default.

See also

Concepts

ClusterType