Share via


IContentList::get_TraceMode, put_TraceMode Property

The TraceMode property is a read/write Boolean that controls whether score tracing is enabled or suppressed.

HRESULT IContentList::get_TraceMode(
  VARIANT_BOOL* TraceMode
);

HRESULT IContentList::put_TraceMode(
  VARIANT_BOOL TraceMode
);
Property TraceMode() As Boolean

Parameters

  • TraceMode
    [C++]

    [out,retval] When getting the property, a pointer to a VARIANT_BOOL used to return the current trace mode setting. A value of True enables score tracing. A value of False suppresses score tracing.

    [in] When putting the property, a VARIANT_BOOL that contains a new trace mode setting. A value of True enables score tracing. A value of False suppresses score tracing.

Return Value

[C++]

These methods return an HRESULT indicating whether they completed successfully. See the Error Values section for more details.

[Visual Basic]

None.

Error Values

[C++]

These methods return S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic]

This property sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

This property acts as a global switch to control whether score tracing is performed. If it is set to True, a SimpleList object of trace messages will be constructed that can be accessed through the TraceMessages property. If it is set to False, score tracing is suppressed.

When you use score tracing, you will notice a dramatic negative effect on performance; score tracing should not be used under normal circumstances. However, it can be useful when you are attempting to troubleshoot a scoring-related issue.

See Also

Other Resources

ContentList Object