Skip to content

Latest commit

 

History

History
77 lines (61 loc) · 3.09 KB

nf-wudfddi-iwdfiotarget-gettargetfile.md

File metadata and controls

77 lines (61 loc) · 3.09 KB
Raw
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:wudfddi.IWDFIoTarget.GetTargetFile
IWDFIoTarget::GetTargetFile (wudfddi.h)
The GetTargetFile method retrieves the framework file object that is associated with the I/O target object.
wdf\iwdfiotarget_gettargetfile.htm
wdf
08/12/2022
IWDFIoTarget::GetTargetFile
GetTargetFile, GetTargetFile method, GetTargetFile method,IWDFIoTarget interface, IWDFIoTarget interface,GetTargetFile method, IWDFIoTarget.GetTargetFile, IWDFIoTarget::GetTargetFile, UMDFIoTargetObjectRef_c31a719b-616e-4559-851a-a9f5c35bc9e5.xml, umdf.iwdfiotarget_gettargetfile, wdf.iwdfiotarget_gettargetfile, wudfddi/IWDFIoTarget::GetTargetFile
wudfddi.h
Wudfddi.h
Desktop
1.5
Unavailable in UMDF 2.0 and later.
WUDFx.dll
Windows
IWDFIoTarget::GetTargetFile
wudfddi/IWDFIoTarget::GetTargetFile
APIRef
kbSyntax
COM
WUDFx.dll
IWDFIoTarget::GetTargetFile

IWDFIoTarget::GetTargetFile

-description

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 GetTargetFile method retrieves the framework file object that is associated with the I/O target object.

-parameters

-param ppWdfFile [out]

Pointer to a buffer that receives a pointer to the IWDFFile interface for the I/O target's file object.

-remarks

If a framework file object is associated with an I/O target object, the framework includes the file object with I/O requests that the driver sends to the I/O target object.

When a driver formats an I/O request, an I/O target object enables the driver to use either the same file that the request started with or a new file.

The default I/O target has no file object, so a call to GetTargetFile for the default I/O target retrieves NULL.

For more information about I/O targets, see Using I/O Targets in UMDF.

Examples

For a code example of how to use the GetTargetFile method, see IWDFIoTarget::FormatRequestForWrite.

-see-also