IUccTraceSettings.TracingEnabled 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 Unified Communications Client API TracingEnabled property.

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

Syntax

'Declaration
ReadOnly Property TracingEnabled As Boolean

bool TracingEnabled { get; }

property bool TracingEnabled {
    bool get ();
}

/** @property */
boolean get_TracingEnabled ()

function get TracingEnabled () : boolean

Property Value

A value of the VARIANT_BOOL* (bool, for a .NET application) type. If the tracing is enabled, the property value is TRUE. Otherwise it is FALSE.

Remarks

This is used to determine if the Unified Communications Client API tracing is enabled or not.

Win32 COM/C++ Syntax

HRESULT get_TracingEnabled
(
    VARIANT_BOOL* pfVal
);

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 Unified Communications Client API Error Codes.

Example

The following example is a public property of an application class that wraps an IUccPlatform object. this.platform is the application class IUccPlatform instance. The get accessor of the property returns the current trace setting, while the set accessor calls EnableTracing or DisableTracing as required by the value.

public Boolean PlatformTracing
{
   get
   {
      IUccTraceSettings traceSettings = this.platform as IUccTraceSettings;
      return traceSettings.TracingEnabled;
   }
   set
   {
      IUccTraceSettings traceSettings = this.platform as IUccTraceSettings;
      if (value == true)
      {
         traceSettings.EnableTracing();
      }
      else
      {
         traceSettings.DisableTracing();
      }
   }
}

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

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