IWDFIoRequest3::SetActivityId method

[Warning: UMDF 2 is the latest version of UMDF and supersedes UMDF 1. All new UMDF drivers should be written using UMDF 2. No new features are being added to UMDF 1 and there is limited support for UMDF 1 on newer versions of Windows 10. Universal Windows drivers must use UMDF 2. For more info, see Getting Started with UMDF.]

The SetActivityId method associates an activity identifier with an I/O request.

Syntax


void SetActivityId(
  [in] LPGUID ActivityId
);

Parameters

ActivityId [in]

A pointer to the activity identifier GUID to store in the I/O request.

Return value

This method does not return a value.

Remarks

Calling SetActivityId does not set an association with any previously present activity identifier. When the driver calls SetActivityId, any existing activity identifier is overwritten.

To set an association, retrieve the existing identifier by calling RetrieveActivityId and then associate the existing identifier with the new one by calling EventWriteTransfer.

The framework does not clear a request's activity identifier when the driver calls IWdfIoRequest2::Reuse.

For more information about activity identifiers, see Using Activity Identifiers.

The UMDF 2 equivalent of this method is WdfRequestSetActivityId.

Examples

For a code example that uses SetActivityId, see RetrieveActivityId.

Requirements

Target platform

Desktop

Minimum support

Windows 8

End of support

Unavailable in UMDF 2.0 and later.

Minimum UMDF version

1.11

Header

Wudfddi.h (include Wudfddi.h)

DLL

WUDFx.dll

See also

IWDFIoRequest3
IWDFIoRequest3::RetrieveActivityId
WdfRequestSetActivityId

 

 

Send comments about this topic to Microsoft

Show: