Skip to content

Latest commit

 

History

History
109 lines (78 loc) · 4.03 KB

nf-winbase-backupseek.md

File metadata and controls

109 lines (78 loc) · 4.03 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:winbase.BackupSeek
BackupSeek function (winbase.h)
Seeks forward in a data stream initially accessed by using the BackupRead or BackupWrite function.
BackupSeek
BackupSeek function [Backup]
_win32_backupseek
backup.backupseek
base.backupseek
winbase/BackupSeek
backup\backupseek.htm
Backup
d5ffba3d-f744-49b4-83e0-e32bd45ecc4c
12/05/2018
BackupSeek, BackupSeek function [Backup], _win32_backupseek, backup.backupseek, base.backupseek, winbase/BackupSeek
winbase.h
Windows.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
Kernel32.lib
Kernel32.dll
Windows
19H1
BackupSeek
winbase/BackupSeek
c++
APIRef
kbSyntax
DllExport
Kernel32.dll
BackupSeek

BackupSeek function

-description

The BackupSeek function seeks forward in a data stream initially accessed by using the BackupRead or BackupWrite function.

-parameters

-param hFile [in]

Handle to the file or directory. This handle is created by using the CreateFile function.

The handle must be synchronous (nonoverlapped). This means that the FILE_FLAG_OVERLAPPED flag must not be set when CreateFile is called. This function does not validate that the handle it receives is synchronous, so it does not return an error code for a synchronous handle, but calling it with an asynchronous (overlapped) handle can result in subtle errors that are very difficult to debug.

-param dwLowBytesToSeek [in]

Low-order part of the number of bytes to seek.

-param dwHighBytesToSeek [in]

High-order part of the number of bytes to seek.

-param lpdwLowByteSeeked [out]

Pointer to a variable that receives the low-order bits of the number of bytes the function actually seeks.

-param lpdwHighByteSeeked [out]

Pointer to a variable that receives the high-order bits of the number of bytes the function actually seeks.

-param lpContext [in]

Pointer to an internal data structure used by the function. This structure must be the same structure that was initialized by the BackupRead or BackupWrite function. An application must not touch the contents of this structure.

-returns

If the function could seek the requested amount, the function returns a nonzero value.

If the function could not seek the requested amount, the function returns zero. To get extended error information, call GetLastError.

-remarks

Applications use the BackupSeek function to skip portions of a data stream that cause errors. This function does not seek across stream headers. For example, this function cannot be used to skip the stream name. If an application attempts to seek past the end of a substream, the function fails, the lpdwLowByteSeeked and lpdwHighByteSeeked parameters indicate the actual number of bytes the function seeks, and the file position is placed at the start of the next stream header.

-see-also

BackupRead

BackupWrite

CreateFile