Win32 API 日本語リファレンス
ホーム › NetworkManagement.P2P › PeerDistClientBlockRead

PeerDistClientBlockRead

関数
クライアントのコンテンツからブロック単位で読み取る。
DLLPeerDist.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

// PeerDist.dll
#include <windows.h>

DWORD PeerDistClientBlockRead(
    INT_PTR hPeerDist,
    INT_PTR hContentHandle,
    DWORD cbMaxNumberOfBytes,
    BYTE* pBuffer,   // optional
    DWORD dwTimeoutInMilliseconds,
    OVERLAPPED* lpOverlapped
);

パラメーター

名前型方向説明
hPeerDistINT_PTRinPeerDistStartup が返した PEERDIST_INSTANCE_HANDLE です。
hContentHandleINT_PTRinPeerDistClientOpenContent 関数の呼び出しによって開かれたコンテンツハンドルです。
cbMaxNumberOfBytesDWORDin読み取る最大バイト数です。cbMaxNumberOfBytesToRead が 0 の場合、PeerDistClientBlockRead 関数が、現在のブロック読み取りオフセットにおいてローカルキャッシュ内で利用可能な連続したコンテンツのバイト数を照会することを示します。この照会では、ピアからコンテンツをダウンロードすることはなく、ピアキャッシュ内に存在するバイト数を返すこともありません。
pBufferBYTE*outoptionalローカルキャッシュからのデータを受け取るバッファーへのポインターです。このバッファーは、読み取り操作が行われている間、有効なままでなければなりません。呼び出し元は、読み取り操作が完了するまでこのバッファーを使用してはなりません。cbMaxNumberOfBytesToRead 引数が 0 の場合、pBuffer パラメーターは NULL でもかまいません。
dwTimeoutInMillisecondsDWORDin

読み取りのタイムアウト値 (ミリ秒単位) です。次の 2 つの特別な値を指定できます。

値 意味
PEERDIST_READ_TIMEOUT_LOCAL_CACHE_ONLY
読み取りにおいて、ピアやホストされたキャッシュ (Hosted Cache) に接続することによる追加のネットワークトラフィックを発生させないことを指定します。
PEERDIST_READ_TIMEOUT_DEFAULT
既定のタイムアウトである 5 秒を指定します。
lpOverlappedOVERLAPPED*inOVERLAPPED 構造体へのポインターです。読み取りの開始オフセットは、OVERLAPPED 構造体の Offset メンバーと OffsetHigh メンバーを設定することで指定します。OffsetHigh メンバーには開始オフセットの上位 32 ビットを、Offset メンバーには開始オフセットの下位 32 ビットを設定します。

戻り値の型: DWORD

公式ドキュメント

PeerDistClientBlockRead 関数は、コンテンツデータのブロックを読み取ります。

戻り値

関数が成功した場合、戻り値は ERROR_IO_PENDING です。それ以外の場合、この関数は次のいずれかの値を返すことがあります。

リターンコード 説明
ERROR_INVALID_PARAMETER
1 つ以上のパラメーターが無効です。
ERROR_INVALID_HANDLE
hPeerDist ハンドルまたは hContent ハンドルが無効です。
ERROR_ACCESS_DISABLED_BY_POLICY
この機能はグループポリシーによって無効にされています。
PEERDIST_ERROR_SERVICE_UNAVAILABLE
サービスが利用できません。

解説(Remarks)

PeerDistClientBlockRead は読み取りをキューに入れ、直ちに呼び出し元に制御を返します。そのため、複数の読み取りを同時に発行できます。 PeerDistClientBlockRead は、データが利用可能になり次第読み取りを完了し、バッファーが完全に満たされるまで待機することはありません。

PeerDistClientBlockRead 関数の操作が正常に完了すると、OVERLAPPED 構造体の Offset フィールドと OffsetHigh フィールドには、読み取りを開始した位置の ULONGLONG オフセットが設定されます。OffsetHigh メンバーにはオフセットの上位 32 ビットが、Offset メンバーにはオフセットの下位 32 ビットが設定されます。GetOverlappedResult は、lpNumberOfBytesTransferred に転送されたバイト数を設定します。呼び出し元が Peer Distribution API の完了処理に完了ポートを使用している場合は、GetQueuedCompletionStatus の lpNumberOfBytes 引数に転送されたバイト数が設定されます。

cbMaxNumberOfBytesToRead 引数が 0 で、PeerDistClientBlockRead 関数が正常に完了した場合、転送されたバイト数 (GetQueuedCompletionStatus または GetOverlappedResult で取得します) には、ローカルキャッシュ内で利用可能なコンテンツの実際の長さが格納されます。

この API が PEERDIST_ERROR_MISSING_DATA または ERROR_TIMEOUT というエラー値で完了した場合、OVERLAPPED 構造体の Offset フィールドと OffsetHigh フィールドは、欠落しているデータ範囲が始まる位置の ULONGLONG オフセットを示します。OffsetHigh メンバーにはオフセットの上位 32 ビットが、Offset メンバーにはオフセットの下位 32 ビットが設定されます。この欠落データ範囲は、元のコンテンツサーバーなどの代替ソースから取得する必要がある部分の開始オフセット (コンテンツの先頭からの相対位置) と長さ (バイト単位) を表します。Peer Distribution サービスが今後同じ読み取りを処理できるようにするには、PeerDistClientAddData を呼び出して、このデータをローカルキャッシュに追加します。欠落データ範囲の長さは、転送されたバイト数 (GetQueuedCompletionStatus または GetOverlappedResult で取得します) によって示されます。

欠落データ範囲は、コンテンツ内の任意のオフセットから始まり、コンテンツの末尾までの任意の長さになり得る点に注意してください。PeerDistClientAddContentInformation に渡したコンテンツ情報が範囲要求に応じて生成されたものである場合、欠落データ範囲は範囲要求の境界内に制限されます。これは、コンテンツサーバー上での PeerDistServerOpenContentInformation の呼び出しで、コンテンツ全体の一部分となるオフセットと長さを指定した場合に発生します。この場合に ERROR_NO_MORE で完了したときは、読み取りオフセットがコンテンツの当該部分範囲の外にあることを示します。

範囲要求

クライアントが元のコンテンツの一部分のみを必要とする場合は、範囲要求を使用してその部分を取得できます。範囲要求には、元のコンテンツにおけるオフセットと長さが含まれます。コンテンツ情報のサイズは、要求するコンテンツのサイズに正比例します。

PeerDistServerOpenContentInformation は、ullContentOffset パラメーターと cbContentLength パラメーターによって、範囲要求用のコンテンツ情報の生成をサポートします。ullContentOffset パラメーターは元のコンテンツ内で範囲が始まるオフセットを表し、cbContentLength は範囲の長さを表します。

クライアントが特定のコンテンツ範囲を表すコンテンツ情報を取得すると、そのコンテンツ情報は PeerDistClientOpenContent、PeerDistClientAddContentInformation、PeerDistClientCompleteContentInformation の各 API とシームレスに連携して動作します。このコンテンツ情報は PeerDistServerOpenContentInformation に渡すことができ、PEERDIST_CONTENT_HANDLE がコンテンツ範囲に関連付けられます。PeerDistClientStreamRead は、サーバー側での PeerDistServerRetrieveContentInformation の呼び出しで指定された ullContentOffset のオフセットと cbContentLength の長さによって制限されます。PeerDistClientStreamRead は ullContentOffset から開始し、ullContentOffset + cbContentLength でコンテンツ範囲の末尾に達すると、エラーコード PEERDIST_ERROR_NO_MORE で完了します。PeerDistClientBlockRead は、OVERLAPPED パラメーターで指定されたオフセットが ullContentOffset より小さい場合、または ullContentOffset + cbContentLength より大きい場合に、エラーコード PEERDIST_ERROR_NO_MORE で完了します。PeerDistClientStreamRead と PeerDistClientBlockRead はいずれも、報告する欠落データの量を、PEERDIST_CONTENT_HANDLE に関連付けられたコンテンツ情報で指定されたコンテンツ範囲に制限します。たとえば、コンテンツ情報がコンテンツの前半のみを表している場合、欠落データはコンテンツの前半に限定されます。その他の点では、PeerDistClientBlockRead と PeerDistClientStreamRead は、コンテンツ全体を扱う場合とまったく同じ方法でコンテンツ範囲を扱います。

クライアントは、PeerDistClientStreamRead または PeerDistClientBlockRead を使用して、PeerDistServerRetrieveContentInformation の呼び出しで指定した ullContentOffset のオフセットから cbContentLength の長さまでのコンテンツを取得できます。クライアントが ullContentOffset と cbContentLength で指定された範囲を超えて読み取ろうとすると、PeerDistClientStreamRead と PeerDistClientBlockRead はどちらも PEERDIST_ERROR_NO_MORE で完了します。さらに PeerDistClientBlockRead は、OVERLAPPED パラメーターで指定されたオフセットが ullContentOffset より小さい場合にも、エラーコード PEERDIST_ERROR_NO_MORE で完了します

ローカルキャッシュからもピアキャッシュからも読み取りを完了できない場合、PeerDistClientStreamRead と PeerDistClientBlockRead はどちらも PEERDIST_ERROR_MISSING_DATA を報告します。範囲指定されたコンテンツ情報を使用している場合、PeerDistClientStreamRead は範囲の開始オフセットから範囲の末尾までを欠落データとして報告します。PeerDistClientBlockRead も、範囲の開始オフセットから範囲の末尾までを欠落データとして報告します。

PeerDistClientAddData では、コンテンツ範囲の外にあるコンテンツデータも追加できます。この範囲外のデータは、対応するコンテンツ情報がローカルキャッシュに追加された後に検証されます。検証されると、そのデータはピアから利用できるようになります。言い換えると、クライアントがコンテンツの前半についてのみコンテンツ情報を追加した場合でも、PeerDistClientAddData によってコンテンツ全体のデータを追加できます。ただし、コンテンツの後半は、対応するコンテンツ情報が追加されるまで検証されません。範囲要求の影響を受ける Peer Distribution API は、これら以外にはありません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// PeerDist.dll
#include <windows.h>

DWORD PeerDistClientBlockRead(
    INT_PTR hPeerDist,
    INT_PTR hContentHandle,
    DWORD cbMaxNumberOfBytes,
    BYTE* pBuffer,   // optional
    DWORD dwTimeoutInMilliseconds,
    OVERLAPPED* lpOverlapped
);
[DllImport("PeerDist.dll", ExactSpelling = true)]
static extern uint PeerDistClientBlockRead(
    IntPtr hPeerDist,   // INT_PTR
    IntPtr hContentHandle,   // INT_PTR
    uint cbMaxNumberOfBytes,   // DWORD
    IntPtr pBuffer,   // BYTE* optional, out
    uint dwTimeoutInMilliseconds,   // DWORD
    IntPtr lpOverlapped   // OVERLAPPED*
);
<DllImport("PeerDist.dll", ExactSpelling:=True)>
Public Shared Function PeerDistClientBlockRead(
    hPeerDist As IntPtr,   ' INT_PTR
    hContentHandle As IntPtr,   ' INT_PTR
    cbMaxNumberOfBytes As UInteger,   ' DWORD
    pBuffer As IntPtr,   ' BYTE* optional, out
    dwTimeoutInMilliseconds As UInteger,   ' DWORD
    lpOverlapped As IntPtr   ' OVERLAPPED*
) As UInteger
End Function
' hPeerDist : INT_PTR
' hContentHandle : INT_PTR
' cbMaxNumberOfBytes : DWORD
' pBuffer : BYTE* optional, out
' dwTimeoutInMilliseconds : DWORD
' lpOverlapped : OVERLAPPED*
Declare PtrSafe Function PeerDistClientBlockRead Lib "peerdist" ( _
    ByVal hPeerDist As LongPtr, _
    ByVal hContentHandle As LongPtr, _
    ByVal cbMaxNumberOfBytes As Long, _
    ByVal pBuffer As LongPtr, _
    ByVal dwTimeoutInMilliseconds As Long, _
    ByVal lpOverlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PeerDistClientBlockRead = ctypes.windll.peerdist.PeerDistClientBlockRead
PeerDistClientBlockRead.restype = wintypes.DWORD
PeerDistClientBlockRead.argtypes = [
    ctypes.c_ssize_t,  # hPeerDist : INT_PTR
    ctypes.c_ssize_t,  # hContentHandle : INT_PTR
    wintypes.DWORD,  # cbMaxNumberOfBytes : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pBuffer : BYTE* optional, out
    wintypes.DWORD,  # dwTimeoutInMilliseconds : DWORD
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PeerDist.dll')
PeerDistClientBlockRead = Fiddle::Function.new(
  lib['PeerDistClientBlockRead'],
  [
    Fiddle::TYPE_INTPTR_T,  # hPeerDist : INT_PTR
    Fiddle::TYPE_INTPTR_T,  # hContentHandle : INT_PTR
    -Fiddle::TYPE_INT,  # cbMaxNumberOfBytes : DWORD
    Fiddle::TYPE_VOIDP,  # pBuffer : BYTE* optional, out
    -Fiddle::TYPE_INT,  # dwTimeoutInMilliseconds : DWORD
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED*
  ],
  -Fiddle::TYPE_INT)
#[link(name = "peerdist")]
extern "system" {
    fn PeerDistClientBlockRead(
        hPeerDist: isize,  // INT_PTR
        hContentHandle: isize,  // INT_PTR
        cbMaxNumberOfBytes: u32,  // DWORD
        pBuffer: *mut u8,  // BYTE* optional, out
        dwTimeoutInMilliseconds: u32,  // DWORD
        lpOverlapped: *mut OVERLAPPED  // OVERLAPPED*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("PeerDist.dll")]
public static extern uint PeerDistClientBlockRead(IntPtr hPeerDist, IntPtr hContentHandle, uint cbMaxNumberOfBytes, IntPtr pBuffer, uint dwTimeoutInMilliseconds, IntPtr lpOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PeerDist_PeerDistClientBlockRead' -Namespace Win32 -PassThru
# $api::PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
#uselib "PeerDist.dll"
#func global PeerDistClientBlockRead "PeerDistClientBlockRead" sptr, sptr, sptr, sptr, sptr, sptr
; PeerDistClientBlockRead hPeerDist, hContentHandle, cbMaxNumberOfBytes, varptr(pBuffer), dwTimeoutInMilliseconds, varptr(lpOverlapped)   ; 戻り値は stat
; hPeerDist : INT_PTR -> "sptr"
; hContentHandle : INT_PTR -> "sptr"
; cbMaxNumberOfBytes : DWORD -> "sptr"
; pBuffer : BYTE* optional, out -> "sptr"
; dwTimeoutInMilliseconds : DWORD -> "sptr"
; lpOverlapped : OVERLAPPED* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "PeerDist.dll"
#cfunc global PeerDistClientBlockRead "PeerDistClientBlockRead" sptr, sptr, int, var, int, var
; res = PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
; hPeerDist : INT_PTR -> "sptr"
; hContentHandle : INT_PTR -> "sptr"
; cbMaxNumberOfBytes : DWORD -> "int"
; pBuffer : BYTE* optional, out -> "var"
; dwTimeoutInMilliseconds : DWORD -> "int"
; lpOverlapped : OVERLAPPED* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD PeerDistClientBlockRead(INT_PTR hPeerDist, INT_PTR hContentHandle, DWORD cbMaxNumberOfBytes, BYTE* pBuffer, DWORD dwTimeoutInMilliseconds, OVERLAPPED* lpOverlapped)
#uselib "PeerDist.dll"
#cfunc global PeerDistClientBlockRead "PeerDistClientBlockRead" intptr, intptr, int, var, int, var
; res = PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
; hPeerDist : INT_PTR -> "intptr"
; hContentHandle : INT_PTR -> "intptr"
; cbMaxNumberOfBytes : DWORD -> "int"
; pBuffer : BYTE* optional, out -> "var"
; dwTimeoutInMilliseconds : DWORD -> "int"
; lpOverlapped : OVERLAPPED* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	peerdist = windows.NewLazySystemDLL("PeerDist.dll")
	procPeerDistClientBlockRead = peerdist.NewProc("PeerDistClientBlockRead")
)

// hPeerDist (INT_PTR), hContentHandle (INT_PTR), cbMaxNumberOfBytes (DWORD), pBuffer (BYTE* optional, out), dwTimeoutInMilliseconds (DWORD), lpOverlapped (OVERLAPPED*)
r1, _, err := procPeerDistClientBlockRead.Call(
	uintptr(hPeerDist),
	uintptr(hContentHandle),
	uintptr(cbMaxNumberOfBytes),
	uintptr(pBuffer),
	uintptr(dwTimeoutInMilliseconds),
	uintptr(lpOverlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function PeerDistClientBlockRead(
  hPeerDist: NativeInt;   // INT_PTR
  hContentHandle: NativeInt;   // INT_PTR
  cbMaxNumberOfBytes: DWORD;   // DWORD
  pBuffer: Pointer;   // BYTE* optional, out
  dwTimeoutInMilliseconds: DWORD;   // DWORD
  lpOverlapped: Pointer   // OVERLAPPED*
): DWORD; stdcall;
  external 'PeerDist.dll' name 'PeerDistClientBlockRead';
result := DllCall("PeerDist\PeerDistClientBlockRead"
    , "Ptr", hPeerDist   ; INT_PTR
    , "Ptr", hContentHandle   ; INT_PTR
    , "UInt", cbMaxNumberOfBytes   ; DWORD
    , "Ptr", pBuffer   ; BYTE* optional, out
    , "UInt", dwTimeoutInMilliseconds   ; DWORD
    , "Ptr", lpOverlapped   ; OVERLAPPED*
    , "UInt")   ; return: DWORD
●PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped) = DLL("PeerDist.dll", "dword PeerDistClientBlockRead(int, int, dword, void*, dword, void*)")
# 呼び出し: PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
# hPeerDist : INT_PTR -> "int"
# hContentHandle : INT_PTR -> "int"
# cbMaxNumberOfBytes : DWORD -> "dword"
# pBuffer : BYTE* optional, out -> "void*"
# dwTimeoutInMilliseconds : DWORD -> "dword"
# lpOverlapped : OVERLAPPED* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "peerdist" fn PeerDistClientBlockRead(
    hPeerDist: isize, // INT_PTR
    hContentHandle: isize, // INT_PTR
    cbMaxNumberOfBytes: u32, // DWORD
    pBuffer: [*c]u8, // BYTE* optional, out
    dwTimeoutInMilliseconds: u32, // DWORD
    lpOverlapped: [*c]OVERLAPPED // OVERLAPPED*
) callconv(std.os.windows.WINAPI) u32;
proc PeerDistClientBlockRead(
    hPeerDist: int,  # INT_PTR
    hContentHandle: int,  # INT_PTR
    cbMaxNumberOfBytes: uint32,  # DWORD
    pBuffer: ptr uint8,  # BYTE* optional, out
    dwTimeoutInMilliseconds: uint32,  # DWORD
    lpOverlapped: ptr OVERLAPPED  # OVERLAPPED*
): uint32 {.importc: "PeerDistClientBlockRead", stdcall, dynlib: "PeerDist.dll".}
pragma(lib, "peerdist");
extern(Windows)
uint PeerDistClientBlockRead(
    ptrdiff_t hPeerDist,   // INT_PTR
    ptrdiff_t hContentHandle,   // INT_PTR
    uint cbMaxNumberOfBytes,   // DWORD
    ubyte* pBuffer,   // BYTE* optional, out
    uint dwTimeoutInMilliseconds,   // DWORD
    OVERLAPPED* lpOverlapped   // OVERLAPPED*
);
ccall((:PeerDistClientBlockRead, "PeerDist.dll"), stdcall, UInt32,
      (Int, Int, UInt32, Ptr{UInt8}, UInt32, Ptr{OVERLAPPED}),
      hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
# hPeerDist : INT_PTR -> Int
# hContentHandle : INT_PTR -> Int
# cbMaxNumberOfBytes : DWORD -> UInt32
# pBuffer : BYTE* optional, out -> Ptr{UInt8}
# dwTimeoutInMilliseconds : DWORD -> UInt32
# lpOverlapped : OVERLAPPED* -> Ptr{OVERLAPPED}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PeerDistClientBlockRead(
    intptr_t hPeerDist,
    intptr_t hContentHandle,
    uint32_t cbMaxNumberOfBytes,
    uint8_t* pBuffer,
    uint32_t dwTimeoutInMilliseconds,
    void* lpOverlapped);
]]
local peerdist = ffi.load("peerdist")
-- peerdist.PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
-- hPeerDist : INT_PTR
-- hContentHandle : INT_PTR
-- cbMaxNumberOfBytes : DWORD
-- pBuffer : BYTE* optional, out
-- dwTimeoutInMilliseconds : DWORD
-- lpOverlapped : OVERLAPPED*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('PeerDist.dll');
const PeerDistClientBlockRead = lib.func('__stdcall', 'PeerDistClientBlockRead', 'uint32_t', ['intptr_t', 'intptr_t', 'uint32_t', 'uint8_t *', 'uint32_t', 'void *']);
// PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
// hPeerDist : INT_PTR -> 'intptr_t'
// hContentHandle : INT_PTR -> 'intptr_t'
// cbMaxNumberOfBytes : DWORD -> 'uint32_t'
// pBuffer : BYTE* optional, out -> 'uint8_t *'
// dwTimeoutInMilliseconds : DWORD -> 'uint32_t'
// lpOverlapped : OVERLAPPED* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("PeerDist.dll", {
  PeerDistClientBlockRead: { parameters: ["isize", "isize", "u32", "pointer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
// hPeerDist : INT_PTR -> "isize"
// hContentHandle : INT_PTR -> "isize"
// cbMaxNumberOfBytes : DWORD -> "u32"
// pBuffer : BYTE* optional, out -> "pointer"
// dwTimeoutInMilliseconds : DWORD -> "u32"
// lpOverlapped : OVERLAPPED* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PeerDistClientBlockRead(
    intptr_t hPeerDist,
    intptr_t hContentHandle,
    uint32_t cbMaxNumberOfBytes,
    uint8_t* pBuffer,
    uint32_t dwTimeoutInMilliseconds,
    void* lpOverlapped);
C, "PeerDist.dll");
// $ffi->PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped);
// hPeerDist : INT_PTR
// hContentHandle : INT_PTR
// cbMaxNumberOfBytes : DWORD
// pBuffer : BYTE* optional, out
// dwTimeoutInMilliseconds : DWORD
// lpOverlapped : OVERLAPPED*
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Peerdist extends StdCallLibrary {
    Peerdist INSTANCE = Native.load("peerdist", Peerdist.class);
    int PeerDistClientBlockRead(
        long hPeerDist,   // INT_PTR
        long hContentHandle,   // INT_PTR
        int cbMaxNumberOfBytes,   // DWORD
        byte[] pBuffer,   // BYTE* optional, out
        int dwTimeoutInMilliseconds,   // DWORD
        Pointer lpOverlapped   // OVERLAPPED*
    );
}
@[Link("peerdist")]
lib LibPeerDist
  fun PeerDistClientBlockRead = PeerDistClientBlockRead(
    hPeerDist : LibC::SSizeT,   # INT_PTR
    hContentHandle : LibC::SSizeT,   # INT_PTR
    cbMaxNumberOfBytes : UInt32,   # DWORD
    pBuffer : UInt8*,   # BYTE* optional, out
    dwTimeoutInMilliseconds : UInt32,   # DWORD
    lpOverlapped : OVERLAPPED*   # OVERLAPPED*
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PeerDistClientBlockReadNative = Uint32 Function(IntPtr, IntPtr, Uint32, Pointer<Uint8>, Uint32, Pointer<Void>);
typedef PeerDistClientBlockReadDart = int Function(int, int, int, Pointer<Uint8>, int, Pointer<Void>);
final PeerDistClientBlockRead = DynamicLibrary.open('PeerDist.dll')
    .lookupFunction<PeerDistClientBlockReadNative, PeerDistClientBlockReadDart>('PeerDistClientBlockRead');
// hPeerDist : INT_PTR -> IntPtr
// hContentHandle : INT_PTR -> IntPtr
// cbMaxNumberOfBytes : DWORD -> Uint32
// pBuffer : BYTE* optional, out -> Pointer<Uint8>
// dwTimeoutInMilliseconds : DWORD -> Uint32
// lpOverlapped : OVERLAPPED* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PeerDistClientBlockRead(
  hPeerDist: NativeInt;   // INT_PTR
  hContentHandle: NativeInt;   // INT_PTR
  cbMaxNumberOfBytes: DWORD;   // DWORD
  pBuffer: Pointer;   // BYTE* optional, out
  dwTimeoutInMilliseconds: DWORD;   // DWORD
  lpOverlapped: Pointer   // OVERLAPPED*
): DWORD; stdcall;
  external 'PeerDist.dll' name 'PeerDistClientBlockRead';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PeerDistClientBlockRead"
  c_PeerDistClientBlockRead :: CIntPtr -> CIntPtr -> Word32 -> Ptr Word8 -> Word32 -> Ptr () -> IO Word32
-- hPeerDist : INT_PTR -> CIntPtr
-- hContentHandle : INT_PTR -> CIntPtr
-- cbMaxNumberOfBytes : DWORD -> Word32
-- pBuffer : BYTE* optional, out -> Ptr Word8
-- dwTimeoutInMilliseconds : DWORD -> Word32
-- lpOverlapped : OVERLAPPED* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let peerdistclientblockread =
  foreign "PeerDistClientBlockRead"
    (intptr_t @-> intptr_t @-> uint32_t @-> (ptr uint8_t) @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* hPeerDist : INT_PTR -> intptr_t *)
(* hContentHandle : INT_PTR -> intptr_t *)
(* cbMaxNumberOfBytes : DWORD -> uint32_t *)
(* pBuffer : BYTE* optional, out -> (ptr uint8_t) *)
(* dwTimeoutInMilliseconds : DWORD -> uint32_t *)
(* lpOverlapped : OVERLAPPED* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library peerdist (t "PeerDist.dll"))
(cffi:use-foreign-library peerdist)

(cffi:defcfun ("PeerDistClientBlockRead" peer-dist-client-block-read :convention :stdcall) :uint32
  (h-peer-dist :int64)   ; INT_PTR
  (h-content-handle :int64)   ; INT_PTR
  (cb-max-number-of-bytes :uint32)   ; DWORD
  (p-buffer :pointer)   ; BYTE* optional, out
  (dw-timeout-in-milliseconds :uint32)   ; DWORD
  (lp-overlapped :pointer))   ; OVERLAPPED*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PeerDistClientBlockRead = Win32::API::More->new('PeerDist',
    'DWORD PeerDistClientBlockRead(LPARAM hPeerDist, LPARAM hContentHandle, DWORD cbMaxNumberOfBytes, LPVOID pBuffer, DWORD dwTimeoutInMilliseconds, LPVOID lpOverlapped)');
# my $ret = $PeerDistClientBlockRead->Call($hPeerDist, $hContentHandle, $cbMaxNumberOfBytes, $pBuffer, $dwTimeoutInMilliseconds, $lpOverlapped);
# hPeerDist : INT_PTR -> LPARAM
# hContentHandle : INT_PTR -> LPARAM
# cbMaxNumberOfBytes : DWORD -> DWORD
# pBuffer : BYTE* optional, out -> LPVOID
# dwTimeoutInMilliseconds : DWORD -> DWORD
# lpOverlapped : OVERLAPPED* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型