ホーム › Networking.WinInet › InternetGetLastResponseInfoW

InternetGetLastResponseInfoW

関数

直近のWinINet操作のエラー応答テキストを取得する(Unicode版)。

DLLWININET.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL InternetGetLastResponseInfoW(
    DWORD* lpdwError,
    LPWSTR lpszBuffer,   // optional
    DWORD* lpdwBufferLength
);

パラメーター

名前	型	方向	説明
lpdwError	DWORD*	out	失敗した操作に関するエラーメッセージを受け取る変数へのポインター。
lpszBuffer	LPWSTR	outoptional	エラーテキストを受け取るバッファーへのポインター。
lpdwBufferLength	DWORD*	inout	lpszBuffer バッファーのサイズを TCHARs 単位で保持する変数へのポインター。関数が返るとき、このパラメーターには、終端のゼロを含まない、バッファーに書き込まれた文字列のサイズが格納されます。

戻り値の型: BOOL

公式ドキュメント

この関数を呼び出したスレッドにおける、直近のエラーの説明またはサーバー応答を取得します。(Unicode)

戻り値

エラーテキストが正常にバッファーに書き込まれた場合は TRUE を返し、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。バッファーがすべてのエラーテキストを保持するには小さすぎる場合、 GetLastError は ERROR_INSUFFICIENT_BUFFER を返し、 lpdwBufferLength パラメーターには、すべてのエラーテキストを返すために必要な最小バッファーサイズが格納されます。

解説(Remarks)

FTP プロトコルは、ほとんどのエラーとともに追加のテキスト情報を返すことがあります。この拡張エラー情報は、 GetLastError が ERROR_INTERNET_EXTENDED_ERROR(関数呼び出しが失敗した後に発生)を返したときに、 InternetGetLastResponseInfo 関数を使用して取得できます。

lpszBuffer が指すバッファーは、エラー文字列と文字列末尾のゼロ終端の両方を保持できるだけの大きさが必要です。ただし、 lpdwBufferLength で返される値には終端のゼロは含まれない点に注意してください。

InternetGetLastResponseInfo は、このスレッドで別の関数が呼び出されるまで、複数回呼び出すことができます。別の関数が呼び出されると、直近の応答情報を格納している内部バッファーはクリアされます。

WinINet API の他のすべての側面と同様に、この関数は DllMain 内やグローバルオブジェクトのコンストラクター・デストラクター内から安全に呼び出すことはできません。

Note WinINet はサーバー実装をサポートしていません。また、サービスから使用すべきではありません。サーバー実装やサービスでは、Microsoft Windows HTTP Services (WinHTTP) を使用してください。

メモ

wininet.h ヘッダーは、InternetGetLastResponseInfo を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL InternetGetLastResponseInfoW(
    DWORD* lpdwError,
    LPWSTR lpszBuffer,   // optional
    DWORD* lpdwBufferLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool InternetGetLastResponseInfoW(
    out uint lpdwError,   // DWORD* out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszBuffer,   // LPWSTR optional, out
    ref uint lpdwBufferLength   // DWORD* in/out
);

<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetGetLastResponseInfoW(
    <Out> ByRef lpdwError As UInteger,   ' DWORD* out
    <MarshalAs(UnmanagedType.LPWStr)> lpszBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef lpdwBufferLength As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpdwError : DWORD* out
' lpszBuffer : LPWSTR optional, out
' lpdwBufferLength : DWORD* in/out
Declare PtrSafe Function InternetGetLastResponseInfoW Lib "wininet" ( _
    ByRef lpdwError As Long, _
    ByVal lpszBuffer As LongPtr, _
    ByRef lpdwBufferLength As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InternetGetLastResponseInfoW = ctypes.windll.wininet.InternetGetLastResponseInfoW
InternetGetLastResponseInfoW.restype = wintypes.BOOL
InternetGetLastResponseInfoW.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # lpdwError : DWORD* out
    wintypes.LPWSTR,  # lpszBuffer : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpdwBufferLength : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetGetLastResponseInfoW = Fiddle::Function.new(
  lib['InternetGetLastResponseInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # lpdwError : DWORD* out
    Fiddle::TYPE_VOIDP,  # lpszBuffer : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpdwBufferLength : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wininet")]
extern "system" {
    fn InternetGetLastResponseInfoW(
        lpdwError: *mut u32,  // DWORD* out
        lpszBuffer: *mut u16,  // LPWSTR optional, out
        lpdwBufferLength: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool InternetGetLastResponseInfoW(out uint lpdwError, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszBuffer, ref uint lpdwBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetGetLastResponseInfoW' -Namespace Win32 -PassThru
# $api::InternetGetLastResponseInfoW(lpdwError, lpszBuffer, lpdwBufferLength)

#uselib "WININET.dll"
#func global InternetGetLastResponseInfoW "InternetGetLastResponseInfoW" wptr, wptr, wptr
; InternetGetLastResponseInfoW varptr(lpdwError), varptr(lpszBuffer), varptr(lpdwBufferLength)   ; 戻り値は stat
; lpdwError : DWORD* out -> "wptr"
; lpszBuffer : LPWSTR optional, out -> "wptr"
; lpdwBufferLength : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global InternetGetLastResponseInfoW "InternetGetLastResponseInfoW" var, var, var
; res = InternetGetLastResponseInfoW(lpdwError, lpszBuffer, lpdwBufferLength)
; lpdwError : DWORD* out -> "var"
; lpszBuffer : LPWSTR optional, out -> "var"
; lpdwBufferLength : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global InternetGetLastResponseInfoW "InternetGetLastResponseInfoW" sptr, sptr, sptr
; res = InternetGetLastResponseInfoW(varptr(lpdwError), varptr(lpszBuffer), varptr(lpdwBufferLength))
; lpdwError : DWORD* out -> "sptr"
; lpszBuffer : LPWSTR optional, out -> "sptr"
; lpdwBufferLength : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。