DkmFileTransferStream.ReadFirst Method

Definition

Overloads

ReadFirst(Byte[], Int32, UInt64, UInt64)

Begins a remote file read operation. The remote file will be opened and bytes up to the size of the content buffer will be transferred. If the file is too large to fit into the content buffer, than ReadNext can be called to read the remaining bytes.

ReadFirst(UInt64, Byte[], Int32, UInt64, UInt64)

Begins a remote file read operation. The remote file will be opened and bytes up to the size of the content buffer will be transferred. If the file is too large to fit into the content buffer, than ReadNext can be called to read the remaining bytes.

This API was introduced in Visual Studio 15 Update 6 (DkmApiVersion.VS15Update6).

ReadFirst(Void*, Int32, Int32, UInt64, UInt64)

Begins a remote file read operation. The remote file will be opened and bytes up to the size of the content buffer will be transferred. If the file is too large to fit into the content buffer, than ReadNext can be called to read the remaining bytes.

ReadFirst(UInt64, Void*, Int32, Int32, UInt64, UInt64)

Begins a remote file read operation. The remote file will be opened and bytes up to the size of the content buffer will be transferred. If the file is too large to fit into the content buffer, than ReadNext can be called to read the remaining bytes.

This API was introduced in Visual Studio 15 Update 6 (DkmApiVersion.VS15Update6).

ReadFirst(Byte[], Int32, UInt64, UInt64)

Begins a remote file read operation. The remote file will be opened and bytes up to the size of the content buffer will be transferred. If the file is too large to fit into the content buffer, than ReadNext can be called to read the remaining bytes.

public:
 void ReadFirst(cli::array <System::Byte> ^ ContentBuffer, [Runtime::InteropServices::Out] int % BytesRead, [Runtime::InteropServices::Out] System::UInt64 % LastWriteTime, [Runtime::InteropServices::Out] System::UInt64 % TotalFileSize);
public void ReadFirst (byte[] ContentBuffer, out int BytesRead, out ulong LastWriteTime, out ulong TotalFileSize);
member this.ReadFirst : byte[] * int * uint64 * uint64 -> unit
Public Sub ReadFirst (ContentBuffer As Byte(), ByRef BytesRead As Integer, ByRef LastWriteTime As ULong, ByRef TotalFileSize As ULong)

Parameters

ContentBuffer
Byte[]

[In,Out] Buffer which receives the starting bytes of the file.

BytesRead
Int32

[Out] Indicates the number of bytes read into the content buffer. This will be the minimum of the file size and the buffer size.

LastWriteTime
UInt64

[Out] The date/time to set for when this file was last modified. The format of this is the same as a Win32 FILETIME structure, which is a 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601.

TotalFileSize
UInt64

[Out] Indicates the size of the file on disk.

Applies to

ReadFirst(UInt64, Byte[], Int32, UInt64, UInt64)

Begins a remote file read operation. The remote file will be opened and bytes up to the size of the content buffer will be transferred. If the file is too large to fit into the content buffer, than ReadNext can be called to read the remaining bytes.

This API was introduced in Visual Studio 15 Update 6 (DkmApiVersion.VS15Update6).

public:
 void ReadFirst(System::UInt64 StartAddress, cli::array <System::Byte> ^ ContentBuffer, [Runtime::InteropServices::Out] int % BytesRead, [Runtime::InteropServices::Out] System::UInt64 % LastWriteTime, [Runtime::InteropServices::Out] System::UInt64 % TotalFileSize);
public void ReadFirst (ulong StartAddress, byte[] ContentBuffer, out int BytesRead, out ulong LastWriteTime, out ulong TotalFileSize);
member this.ReadFirst : uint64 * byte[] * int * uint64 * uint64 -> unit
Public Sub ReadFirst (StartAddress As ULong, ContentBuffer As Byte(), ByRef BytesRead As Integer, ByRef LastWriteTime As ULong, ByRef TotalFileSize As ULong)

Parameters

StartAddress
UInt64

[In] The address at which to begin reading the remote file.

ContentBuffer
Byte[]

[In,Out] Buffer which receives the starting bytes of the file.

BytesRead
Int32

[Out] Indicates the number of bytes read into the content buffer. This will be the minimum of the file size and the buffer size.

LastWriteTime
UInt64

[Out] The date/time to set for when this file was last modified. The format of this is the same as a Win32 FILETIME structure, which is a 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601.

TotalFileSize
UInt64

[Out] Indicates the size of the file on disk.

Applies to

ReadFirst(Void*, Int32, Int32, UInt64, UInt64)

Begins a remote file read operation. The remote file will be opened and bytes up to the size of the content buffer will be transferred. If the file is too large to fit into the content buffer, than ReadNext can be called to read the remaining bytes.

public:
 void ReadFirst(void* ContentBuffer, int BufferSize, [Runtime::InteropServices::Out] int % BytesRead, [Runtime::InteropServices::Out] System::UInt64 % LastWriteTime, [Runtime::InteropServices::Out] System::UInt64 % TotalFileSize);
public void ReadFirst (void* ContentBuffer, int BufferSize, out int BytesRead, out ulong LastWriteTime, out ulong TotalFileSize);
member this.ReadFirst : nativeptr<unit> * int * int * uint64 * uint64 -> unit

Parameters

ContentBuffer
Void*

[In,Out] Buffer which receives the starting bytes of the file.

BufferSize
Int32

[In] Indicates the size of the content buffer.

BytesRead
Int32

[Out] Indicates the number of bytes read into the content buffer. This will be the minimum of the file size and the buffer size.

LastWriteTime
UInt64

[Out] The date/time to set for when this file was last modified. The format of this is the same as a Win32 FILETIME structure, which is a 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601.

TotalFileSize
UInt64

[Out] Indicates the size of the file on disk.

Applies to

ReadFirst(UInt64, Void*, Int32, Int32, UInt64, UInt64)

Begins a remote file read operation. The remote file will be opened and bytes up to the size of the content buffer will be transferred. If the file is too large to fit into the content buffer, than ReadNext can be called to read the remaining bytes.

This API was introduced in Visual Studio 15 Update 6 (DkmApiVersion.VS15Update6).

public:
 void ReadFirst(System::UInt64 StartAddress, void* ContentBuffer, int BufferSize, [Runtime::InteropServices::Out] int % BytesRead, [Runtime::InteropServices::Out] System::UInt64 % LastWriteTime, [Runtime::InteropServices::Out] System::UInt64 % TotalFileSize);
public void ReadFirst (ulong StartAddress, void* ContentBuffer, int BufferSize, out int BytesRead, out ulong LastWriteTime, out ulong TotalFileSize);
member this.ReadFirst : uint64 * nativeptr<unit> * int * int * uint64 * uint64 -> unit

Parameters

StartAddress
UInt64

[In] The address at which to begin reading the remote file.

ContentBuffer
Void*

[In,Out] Buffer which receives the starting bytes of the file.

BufferSize
Int32

[In] Indicates the size of the content buffer.

BytesRead
Int32

[Out] Indicates the number of bytes read into the content buffer. This will be the minimum of the file size and the buffer size.

LastWriteTime
UInt64

[Out] The date/time to set for when this file was last modified. The format of this is the same as a Win32 FILETIME structure, which is a 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601.

TotalFileSize
UInt64

[Out] Indicates the size of the file on disk.

Applies to