Win32 API 日本語リファレンス
ホームSystem.IO › OVERLAPPED

OVERLAPPED

構造体
サイズx64: 32 バイト / x86: 16 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
InternalUINT_PTR8/4+0+0

I/O 要求のステータスコードです。要求が発行されると、システムは操作がまだ開始されていないことを示すために、このメンバーを STATUS_PENDING に設定します。要求が完了すると、システムはこのメンバーを完了した要求のステータスコードに設定します。

Internal メンバーは元来システム用に予約されていたものであり、その動作は変更される可能性があります。

InternalHighUINT_PTR8/4+8+4

I/O 要求で転送されたバイト数です。要求がエラーなく完了した場合、システムはこのメンバーを設定します。

InternalHigh メンバーは元来システム用に予約されていたものであり、その動作は変更される可能性があります。

Anonymous_Anonymous_e__Union8/4+16+8ファイル操作の開始オフセット(Offset/OffsetHigh)またはhEvent用のポインタを保持する無名共用体である。
hEventHANDLE8/4+24+12

操作が完了したときに、システムによってシグナル状態に設定されるイベントのハンドルです。この構造体をオーバーラップ関数に渡す前に、ユーザーはこのメンバーを 0 に初期化するか、CreateEvent 関数を使用して取得した有効なイベントハンドルに初期化しなければなりません。このイベントは、デバイスに対する同時 I/O 要求を同期するために使用できます。詳細については、「解説」を参照してください。

ReadFileWriteFile などの関数は、I/O 操作を開始する前にこのハンドルを非シグナル状態に設定します。操作が完了すると、ハンドルはシグナル状態に設定されます。

GetOverlappedResult や同期用の待機関数などの関数は、自動リセットイベントを非シグナル状態にリセットします。そのため、手動リセットイベントを使用してください。自動リセットイベントを使用すると、操作の完了を待機してから GetOverlappedResultbWait パラメーターに TRUE を設定して呼び出した場合に、アプリケーションが応答しなくなる可能性があります。

共用体: _Anonymous_e__Union x64 8B / x86 4B

フィールドサイズx64x86説明
Anonymous_Anonymous_e__Struct8/4+0+0ファイル操作の開始オフセット(Offset/OffsetHigh)またはhEvent用のポインタを保持する無名共用体である。
Pointervoid*8/4+0+0システム用に予約済みです。0 に初期化した後は使用しないでください。

公式ドキュメント

非同期 (またはオーバーラップ) 入出力 (I/O) で使用される情報を格納します。

解説(Remarks)

この構造体を関数呼び出しで使用する前に、使用しないメンバーは必ず 0 に初期化してください。そうしないと、関数が失敗して ERROR_INVALID_PARAMETER を返す可能性があります。

Offset メンバーと OffsetHigh メンバーは、あわせて 64 ビットのファイル位置を表します。これはファイルまたはファイル的なデバイスの先頭からのバイトオフセットであり、ユーザーが指定します。システムがこれらの値を変更することはありません。呼び出し側プロセスは、OVERLAPPED 構造体を、 ReadFileWriteFile (および関連する) 関数など、オフセットを使用する関数に渡す前に、このメンバーを設定しなければなりません。

HasOverlappedIoCompleted マクロを使用すると、GetOverlappedResult がアプリケーションにとって煩雑すぎる場合でも、非同期 I/O 操作が完了したかどうかを確認できます。

非同期 I/O 操作をキャンセルするには、 CancelIo 関数を使用できます。

よくある間違いは、直前の非同期操作が完了する前に OVERLAPPED 構造体を再利用することです。要求ごとに別々の構造体を使用してください。また、データを処理するスレッドごとにイベントオブジェクトを作成してください。イベントハンドルを配列に格納しておけば、WaitForMultipleObjects 関数を使用してすべてのイベントがシグナル状態になるのを簡単に待機できます。

非同期 I/O の使用に関する詳細と、陥りやすい問題については、CreateFileReadFileWriteFile および関連する関数を参照してください。

同期処理の全般的な概要と OVERLAPPED の概念的な使用方法については、Synchronization and Overlapped Input and Output および関連するトピックを参照してください。

同期 I/O と非同期 I/O について、ファイル I/O の観点からの概要は Synchronous and Asynchronous I/O を参照してください。

例については、Named Pipe Server Using Overlapped I/O を参照してください。

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

各言語での定義

#include <windows.h>

// OVERLAPPED  (x64 32 / x86 16 バイト)
typedef struct OVERLAPPED {
    UINT_PTR Internal;
    UINT_PTR InternalHigh;
    _Anonymous_e__Union Anonymous;
    HANDLE hEvent;
} OVERLAPPED;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct OVERLAPPED
{
    public UIntPtr Internal;
    public UIntPtr InternalHigh;
    public _Anonymous_e__Union Anonymous;
    public IntPtr hEvent;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure OVERLAPPED
    Public Internal As UIntPtr
    Public InternalHigh As UIntPtr
    Public Anonymous As _Anonymous_e__Union
    Public hEvent As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class OVERLAPPED(ctypes.Structure):
    _fields_ = [
        ("Internal", ctypes.c_size_t),
        ("InternalHigh", ctypes.c_size_t),
        ("Anonymous", _Anonymous_e__Union),
        ("hEvent", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct OVERLAPPED {
    pub Internal: usize,
    pub InternalHigh: usize,
    pub Anonymous: _Anonymous_e__Union,
    pub hEvent: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type OVERLAPPED struct {
	Internal uintptr
	InternalHigh uintptr
	Anonymous _Anonymous_e__Union
	hEvent uintptr
}
type
  OVERLAPPED = record
    Internal: NativeUInt;
    InternalHigh: NativeUInt;
    Anonymous: _Anonymous_e__Union;
    hEvent: Pointer;
  end;
const OVERLAPPED = extern struct {
    Internal: usize,
    InternalHigh: usize,
    Anonymous: _Anonymous_e__Union,
    hEvent: ?*anyopaque,
};
type
  OVERLAPPED {.bycopy.} = object
    Internal: uint
    InternalHigh: uint
    Anonymous: _Anonymous_e__Union
    hEvent: pointer
struct OVERLAPPED
{
    size_t Internal;
    size_t InternalHigh;
    _Anonymous_e__Union Anonymous;
    void* hEvent;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; OVERLAPPED サイズ: 16 バイト(x86)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; Internal : UINT_PTR (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; InternalHigh : UINT_PTR (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Anonymous : _Anonymous_e__Union (+8, 4byte)  varptr(st)+8 を基点に操作(4byte:入れ子/配列)
; hEvent : HANDLE (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; OVERLAPPED サイズ: 32 バイト(x64)
dim st, 8    ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; Internal : UINT_PTR (+0, 8byte)  qpoke st,0,値 / qpeek(st,0)  ※IronHSPのみ。3.7/3.8は lpoke st,0,下位 : lpoke st,4,上位
; InternalHigh : UINT_PTR (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; Anonymous : _Anonymous_e__Union (+16, 8byte)  varptr(st)+16 を基点に操作(8byte:入れ子/配列)
; hEvent : HANDLE (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global OVERLAPPED
    #field intptr Internal
    #field intptr InternalHigh
    #field byte Anonymous 8
    #field intptr hEvent
#endstruct

stdim st, OVERLAPPED        ; NSTRUCT 変数を確保
st->Internal = 100
mes "Internal=" + st->Internal
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。