ホーム › Networking.WinInet › InternetGetLastResponseInfoA

InternetGetLastResponseInfoA

関数

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

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

シグネチャ

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL InternetGetLastResponseInfoA(
    DWORD* lpdwError,
    LPSTR lpszBuffer,   // optional
    DWORD* lpdwBufferLength
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

解説(Remarks)

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

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

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

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

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

メモ

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

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

各言語での呼び出し定義

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL InternetGetLastResponseInfoA(
    DWORD* lpdwError,
    LPSTR lpszBuffer,   // optional
    DWORD* lpdwBufferLength
);

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

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

' lpdwError : DWORD* out
' lpszBuffer : LPSTR optional, out
' lpdwBufferLength : DWORD* in/out
Declare PtrSafe Function InternetGetLastResponseInfoA Lib "wininet" ( _
    ByRef lpdwError As Long, _
    ByVal lpszBuffer As String, _
    ByRef lpdwBufferLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InternetGetLastResponseInfoA = ctypes.windll.wininet.InternetGetLastResponseInfoA
InternetGetLastResponseInfoA.restype = wintypes.BOOL
InternetGetLastResponseInfoA.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # lpdwError : DWORD* out
    wintypes.LPSTR,  # lpszBuffer : LPSTR 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')
InternetGetLastResponseInfoA = Fiddle::Function.new(
  lib['InternetGetLastResponseInfoA'],
  [
    Fiddle::TYPE_VOIDP,  # lpdwError : DWORD* out
    Fiddle::TYPE_VOIDP,  # lpszBuffer : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpdwBufferLength : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn InternetGetLastResponseInfoA(
        lpdwError: *mut u32,  // DWORD* out
        lpszBuffer: *mut u8,  // LPSTR 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.Ansi, SetLastError = true)]
public static extern bool InternetGetLastResponseInfoA(out uint lpdwError, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszBuffer, ref uint lpdwBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetGetLastResponseInfoA' -Namespace Win32 -PassThru
# $api::InternetGetLastResponseInfoA(lpdwError, lpszBuffer, lpdwBufferLength)

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

出力引数:

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