TlsGetValue

指定した TLS インデックスについて、呼び出し側スレッドのスレッドローカルストレージ (TLS) スロット内の値を取得する。プロセスの各スレッドは TLS インデックスごとに独自のスロットを持つ。

TlsGetValue dwTlsIndex

dwTlsIndex : [int] TlsAlloc 関数で割り当てられた TLS インデックス。

(プラグイン / モジュール : kernel32.dll)

解説

指定した TLS インデックスについて、呼び出し側スレッドのスレッドローカルストレージ (TLS)
スロット内の値を取得する。プロセスの各スレッドは TLS インデックスごとに独自のスロットを持つ。

[戻り値]
関数が成功した場合、戻り値は呼び出し側スレッドの TLS スロットに格納された値。dwTlsIndex が TlsAlloc
で正常に割り当てられた有効なインデックスであれば常に成功する。関数が失敗した場合、戻り値は 0。拡張エラー情報を取得するには
GetLastError を呼ぶ。TLS スロットに格納されたデータは、初期値のままであるか TlsSetValue で 0
を格納された場合、0 となる。よって戻り値が 0 のときは関数が失敗したと判断する前に GetLastError が
ERROR_SUCCESS を返すか確認する必要がある。失敗を返す関数は通常失敗時のみ SetLastError
を呼ぶが、TlsGetValue は成功時にも SetLastError を呼んでスレッドのラストエラーをクリアする例外で、これにより 0
値の正常取得を判別できる。

[備考]
Windows Phone 8.1 / Windows 8.1 / Windows Server 2012 R2 / Windows 10
version 1507: 本関数は対応 Windows Phone / Windows
ストアアプリでサポートされ、FlsGetValue へのインライン呼び出しに置換される。Windows 10 version 1511
以降: 本関数は UWP アプリで完全にサポートされ、もはや置換されない。TLS インデックスは通常 TlsAlloc によりプロセスや
DLL 初期化中に割り当てられる。割り当て後、プロセスの各スレッドはその TLS
スロットへアクセスするためにそのインデックスを使える。スレッドは TlsSetValue
にインデックスを指定してスロットに値を格納し、後の TlsGetValue で取り出す。TlsGetValue
は速度を最優先に実装されている。本関数はパラメータ検証とエラーチェックを最小限しか行わず、特に dwTlsIndex が 0 から
TLS_MINIMUM_AVAILABLE-1 の範囲内であれば成功する。インデックスが有効であり、TlsGetValue
を呼ぶ前にスレッドが TlsSetValue を呼んでいることを確認するのはプログラマの責任である。

情報