Activity::SetTrace method

Sets Trace settings of the Activity.

Syntax

virtual HRESULT SetTrace(
  [in]            LPCWSTR traceFile,
  [in, optional]  LPCWSTR traceLink,
  [in, optional]  LPCWSTR traceName,
  [in, optional]  LPCWSTR traceTooltip,
  [out, optional] Trace   **trace
) = 0;

Parameters

traceFile [in]

The trace file name.

traceLink [in, optional]

The trace link.

traceName [in, optional]

The trace name.

traceTooltip [in, optional]

The trace tooltip.

trace [out, optional]

The Trace that this method sets.

Return value

If the function succeeds, it returns S_OK. If it fails, it returns an error value.

Remarks

Activity objects hold data from Iteration/Activities/Activity elements.

The Trace holds values from element Activity/Trace.

The trace file name is the value of element Activity/Trace/File.

The trace link is the value of element Activity/Trace/Link.

The trace name is the value of element Activity/Trace/Description/Name.

The trace tooltip is the value of element Activity/Trace/Description/ToolTip.

Requirements

See also

Activity