Skip to content

Latest commit

 

History

History
112 lines (87 loc) · 3.31 KB

nf-imapi2-idiscformat2data-cancelwrite.md

File metadata and controls

112 lines (87 loc) · 3.31 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date 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 req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:imapi2.IDiscFormat2Data.CancelWrite
IDiscFormat2Data::CancelWrite (imapi2.h)
Cancels the current write operation. (IDiscFormat2Data.CancelWrite)
CancelWrite
CancelWrite method [IMAPI]
CancelWrite method [IMAPI]
IDiscFormat2Data interface
IDiscFormat2Data interface [IMAPI]
CancelWrite method
IDiscFormat2Data.CancelWrite
IDiscFormat2Data::CancelWrite
imapi.idiscformat2data_cancelwrite
imapi2/IDiscFormat2Data::CancelWrite
imapi\idiscformat2data_cancelwrite.htm
imapi
0fe5705e-7f48-4a4e-a535-a3dd105a6139
12/05/2018
CancelWrite, CancelWrite method [IMAPI], CancelWrite method [IMAPI],IDiscFormat2Data interface, IDiscFormat2Data interface [IMAPI],CancelWrite method, IDiscFormat2Data.CancelWrite, IDiscFormat2Data::CancelWrite, imapi.idiscformat2data_cancelwrite, imapi2/IDiscFormat2Data::CancelWrite
imapi2.h
Windows
Windows Vista, Windows XP with SP2 [desktop apps only]
Windows Server 2003 [desktop apps only]
Imapi2.idl
Windows
19H1
IDiscFormat2Data::CancelWrite
imapi2/IDiscFormat2Data::CancelWrite
c++
APIRef
kbSyntax
COM
imapi2.h
IDiscFormat2Data.CancelWrite

IDiscFormat2Data::CancelWrite

-description

Cancels the current write operation.

-returns

S_OK is returned on success, but other success codes may be returned as a result of implementation. The following error codes are commonly returned on operation failure, but do not represent the only possible error values:

Return code Description
E_IMAPI_DF2DATA_WRITE_NOT_IN_PROGRESS
There is no write operation currently in progress.

Value: 0xC0AA0401

E_FAIL
Unspecified failure.

Value: 0x80004005

-remarks

To cancel the write operation, you must call this method from the DDiscFormat2DataEvents::Update event handler that you implemented.

Note that calling this method does not immediately cancel the write operation on all media due to media-specific requirements. For example, when writing to a CD, the write operation can continue for up to three more minutes.

This method leaves the media in an indeterminate state. For rewriteable media, you should call the IDiscFormat2Erase::EraseMedia method after calling this method to prepare the media for future use.

-see-also

DWriteEngine2Events

IDiscFormat2Data

IDiscFormat2Data::Write