IUccPresentity.SourceType Property

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Gets the type of the network in which the publisher is a registered user.

Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)

Syntax

'Declaration
ReadOnly Property SourceType As UCC_SOURCE_NETWORK_TYPE

UCC_SOURCE_NETWORK_TYPE SourceType { get; }

property UCC_SOURCE_NETWORK_TYPE SourceType {
    UCC_SOURCE_NETWORK_TYPE get ();
}

/** @property */
UCC_SOURCE_NETWORK_TYPE get_SourceType ()

function get SourceType () : UCC_SOURCE_NETWORK_TYPE

Property Value

A value of the UCC_SOURCE_NETWORK_TYPE* (UCC_SOURCE_NETWORK_TYPE, for a .NET application) type.

Remarks

The value of this property is determined by the type of network to which the publishing user belongs. A SourceType of UCC_SOURCE_NETWORK_TYPE.UCCSNT_COMPANY indicates the publishing user is a member of the same enterprise as the subscribing user. The publishing user may be connected to the common SIP server via an enterprise intranet with the subscribing user or be connected to the common SIP server via an internet connection.

A SourceType of UCC_SOURCE_NETWORK_TYPE.UCCSNT_FEDERATED_ENTERPRISE indicates the publishing user is a member of another enterprise whose SIP server interoperates with the subscribing user's SIP server. The federated user posseses credentials which are recognized by the subscribing user's enterprise SIP server. The distinction between UCC_SOURCE_NETWORK_TYPE.UCCSNT_COMPANY and UCC_SOURCE_NETWORK_TYPE.UCCSNT_FEDERATED_ENTERPRISE OR UCC_SOURCE_NETWORK_TYPE.UCCSNT_FEDERATED_PUBLIC is important to a client application when the subscribed user is a Unified Communications client, but a different enterprise.

Win32 COM/C++ Syntax

HRESULT get_SourceType
(
   UCC_SOURCE_NETWORK_TYPE* penSourceType
);

Note

In a Win32 application, the return value of a method or property is always an HRESULT value indicating the status of the call to the interface member. Any result of the operation is returned as a parameter marked with the [out, retval] attribute. In contrast, in a .NET application the HRESULT value indicating an error condition is returned as a COM exception and the [out, retval] parameter becomes the return value. For the UCC API-defined HRESULT values, see Trace and Handle Errors in Unified Communications Client API.

Example

The following example is a public property exposed by an application class that wraps a contact (IUccPresentity) instance. The example property returns a Booleantrue value if the remote contact belongs to the same enterprise.

public Boolean ContactIsSameEnterprise(IUccPresentity pContact)
{
   Boolean returnValue = false;
   if (pContact.SourceType == UCC_SOURCE_NETWORK_TYPE.UCCSNT_COMPANY)
   {
      returnValue = true;
   }
   return returnValue;
}

Thread Safety

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2000 with Service Pack 4, Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

IUccPresentity Interface
IUccPresentity Members
Microsoft.Office.Interop.UccApi Namespace