NtWriteFileGather

2OO1, 14 February

NtWriteFileGather

NTSYSAPI 
NTSTATUS
NTAPI


NtWriteFileGather(



  IN HANDLE               FileHandle,
  IN HANDLE               Event OPTIONAL,
  IN PIO_APC_ROUTINE      ApcRoutine OPTIONAL,
  IN PVOID                ApcContext OPTIONAL,
  OUT PIO_STATUS_BLOCK    IoStatusBlock,
  IN FILE_SEGMENT_ELEMENT SegmentArray,
  IN ULONG                Length,
  IN PLARGE_INTEGER       ByteOffset,
  IN PULONG               Key OPTIONAL );

Function NtWriteFileGather writes specified block of file with data from memory pages. See NtReadFileScatter for more information.

FileHandle HANDLE to File Object opened with FILE_WRITE_DATA access and FILE_NO_INTERMEDIATE_BUFFERING open option.
Warring: You cannot use File Object opened with FILE_APPEND_DATA access.

Event HANDLE to Event Object signaled when writing will finish. Function always use asynchronous writing operation, so caller should define Event or ApcRoutine parameter.

ApcRoutine Pointer to user's APC Routine.

ApcContext Parameter for ApcRoutine.

IoStatusBlock IO result of call.

SegmentArray Array of FILE_SEGMENT_ELEMENT elements pointing to memory pages to write. Last array element must be NULL.

Length Number of bytes to write.

ByteOffset Pointer to LARGE_INTEGER value indicates starting position for write.

Key Pointer to user's defined key, used when file is locked (see NtLockFile).

Documented by:

Tomasz Nowak

Requirements:

Library: ntdll.lib

Undocumented functions of NTDLL