ホーム › Networking.WinInet › GopherGetAttributeA

GopherGetAttributeA

関数

Gopher項目の属性情報を取得して列挙する(ANSI版)。

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

シグネチャ

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

BOOL GopherGetAttributeA(
    void* hConnect,
    LPCSTR lpszLocator,
    LPCSTR lpszAttributeName,   // optional
    BYTE* lpBuffer,
    DWORD dwBufferLength,
    DWORD* lpdwCharactersReturned,
    GOPHER_ATTRIBUTE_ENUMERATOR lpfnEnumerator,   // optional
    UINT_PTR dwContext   // optional
);

パラメーター

名前	型	方向	説明
hConnect	void*	in	InternetConnect が返した Gopher セッションのハンドル。
lpszLocator	LPCSTR	in	属性情報を返す対象となる Gopher サーバー上の項目を識別する、null 終端文字列へのポインター。
lpszAttributeName	LPCSTR	inoptional	返す属性の名前を指定する、スペース区切りの文字列へのポインター。 lpszAttributeName が NULL の場合、 GopherGetAttribute はすべての属性に関する情報を返します。
lpBuffer	BYTE*	out	属性情報を取得する先となる、アプリケーション定義のバッファーへのポインター。
dwBufferLength	DWORD	in	lpBuffer バッファーのサイズ(TCHAR 単位)。
lpdwCharactersReturned	DWORD*	out	lpBuffer バッファーに読み込まれた文字数を格納する変数へのポインター。
lpfnEnumerator	GOPHER_ATTRIBUTE_ENUMERATOR	inoptional	ロケーターの各属性を列挙する GopherAttributeEnumerator コールバック関数へのポインター。このパラメーターは省略可能です。NULL の場合、すべての Gopher 属性情報が lpBuffer に格納されます。 lpfnEnumerator が指定されている場合、コールバック関数はオブジェクトの属性ごとに 1 回呼び出されます。コールバック関数は、呼び出しごとに 1 つの GOPHER_ATTRIBUTE_TYPE 構造体のアドレスを受け取ります。この列挙コールバック関数により、アプリケーションは Gopher 属性情報を解析する必要がなくなります。
dwContext	UINT_PTR	inoptional	この操作を任意のアプリケーションデータに関連付ける、アプリケーション定義の値。

戻り値の型: BOOL

公式ドキュメント

サーバーから特定の属性情報を取得します。(ANSI)

戻り値

要求が満たされた場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError または InternetGetLastResponseInfo を呼び出します。

解説(Remarks)

通常、アプリケーションはこの関数を GopherFindFirstFile または InternetFindNextFile を呼び出した後に呼び出します。

lpBuffer パラメーターのサイズは、MIN_GOPHER_ATTRIBUTE_LENGTH の値以上である必要があります。

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GopherGetAttributeA(
    void* hConnect,
    LPCSTR lpszLocator,
    LPCSTR lpszAttributeName,   // optional
    BYTE* lpBuffer,
    DWORD dwBufferLength,
    DWORD* lpdwCharactersReturned,
    GOPHER_ATTRIBUTE_ENUMERATOR lpfnEnumerator,   // optional
    UINT_PTR dwContext   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GopherGetAttributeA(
    IntPtr hConnect,   // void*
    [MarshalAs(UnmanagedType.LPStr)] string lpszLocator,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpszAttributeName,   // LPCSTR optional
    IntPtr lpBuffer,   // BYTE* out
    uint dwBufferLength,   // DWORD
    out uint lpdwCharactersReturned,   // DWORD* out
    IntPtr lpfnEnumerator,   // GOPHER_ATTRIBUTE_ENUMERATOR optional
    UIntPtr dwContext   // UINT_PTR optional
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GopherGetAttributeA(
    hConnect As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPStr)> lpszLocator As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszAttributeName As String,   ' LPCSTR optional
    lpBuffer As IntPtr,   ' BYTE* out
    dwBufferLength As UInteger,   ' DWORD
    <Out> ByRef lpdwCharactersReturned As UInteger,   ' DWORD* out
    lpfnEnumerator As IntPtr,   ' GOPHER_ATTRIBUTE_ENUMERATOR optional
    dwContext As UIntPtr   ' UINT_PTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hConnect : void*
' lpszLocator : LPCSTR
' lpszAttributeName : LPCSTR optional
' lpBuffer : BYTE* out
' dwBufferLength : DWORD
' lpdwCharactersReturned : DWORD* out
' lpfnEnumerator : GOPHER_ATTRIBUTE_ENUMERATOR optional
' dwContext : UINT_PTR optional
Declare PtrSafe Function GopherGetAttributeA Lib "wininet" ( _
    ByVal hConnect As LongPtr, _
    ByVal lpszLocator As String, _
    ByVal lpszAttributeName As String, _
    ByVal lpBuffer As LongPtr, _
    ByVal dwBufferLength As Long, _
    ByRef lpdwCharactersReturned As Long, _
    ByVal lpfnEnumerator As LongPtr, _
    ByVal dwContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GopherGetAttributeA = ctypes.windll.wininet.GopherGetAttributeA
GopherGetAttributeA.restype = wintypes.BOOL
GopherGetAttributeA.argtypes = [
    ctypes.POINTER(None),  # hConnect : void*
    wintypes.LPCSTR,  # lpszLocator : LPCSTR
    wintypes.LPCSTR,  # lpszAttributeName : LPCSTR optional
    ctypes.POINTER(ctypes.c_ubyte),  # lpBuffer : BYTE* out
    wintypes.DWORD,  # dwBufferLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpdwCharactersReturned : DWORD* out
    ctypes.c_void_p,  # lpfnEnumerator : GOPHER_ATTRIBUTE_ENUMERATOR optional
    ctypes.c_size_t,  # dwContext : UINT_PTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
GopherGetAttributeA = Fiddle::Function.new(
  lib['GopherGetAttributeA'],
  [
    Fiddle::TYPE_VOIDP,  # hConnect : void*
    Fiddle::TYPE_VOIDP,  # lpszLocator : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszAttributeName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpBuffer : BYTE* out
    -Fiddle::TYPE_INT,  # dwBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # lpdwCharactersReturned : DWORD* out
    Fiddle::TYPE_VOIDP,  # lpfnEnumerator : GOPHER_ATTRIBUTE_ENUMERATOR optional
    Fiddle::TYPE_UINTPTR_T,  # dwContext : UINT_PTR optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn GopherGetAttributeA(
        hConnect: *mut (),  // void*
        lpszLocator: *const u8,  // LPCSTR
        lpszAttributeName: *const u8,  // LPCSTR optional
        lpBuffer: *mut u8,  // BYTE* out
        dwBufferLength: u32,  // DWORD
        lpdwCharactersReturned: *mut u32,  // DWORD* out
        lpfnEnumerator: *const core::ffi::c_void,  // GOPHER_ATTRIBUTE_ENUMERATOR optional
        dwContext: usize  // UINT_PTR optional
    ) -> 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 GopherGetAttributeA(IntPtr hConnect, [MarshalAs(UnmanagedType.LPStr)] string lpszLocator, [MarshalAs(UnmanagedType.LPStr)] string lpszAttributeName, IntPtr lpBuffer, uint dwBufferLength, out uint lpdwCharactersReturned, IntPtr lpfnEnumerator, UIntPtr dwContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_GopherGetAttributeA' -Namespace Win32 -PassThru
# $api::GopherGetAttributeA(hConnect, lpszLocator, lpszAttributeName, lpBuffer, dwBufferLength, lpdwCharactersReturned, lpfnEnumerator, dwContext)

#uselib "WININET.dll"
#func global GopherGetAttributeA "GopherGetAttributeA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; GopherGetAttributeA hConnect, lpszLocator, lpszAttributeName, varptr(lpBuffer), dwBufferLength, varptr(lpdwCharactersReturned), lpfnEnumerator, dwContext   ; 戻り値は stat
; hConnect : void* -> "sptr"
; lpszLocator : LPCSTR -> "sptr"
; lpszAttributeName : LPCSTR optional -> "sptr"
; lpBuffer : BYTE* out -> "sptr"
; dwBufferLength : DWORD -> "sptr"
; lpdwCharactersReturned : DWORD* out -> "sptr"
; lpfnEnumerator : GOPHER_ATTRIBUTE_ENUMERATOR optional -> "sptr"
; dwContext : UINT_PTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global GopherGetAttributeA "GopherGetAttributeA" sptr, str, str, var, int, var, sptr, sptr
; res = GopherGetAttributeA(hConnect, lpszLocator, lpszAttributeName, lpBuffer, dwBufferLength, lpdwCharactersReturned, lpfnEnumerator, dwContext)
; hConnect : void* -> "sptr"
; lpszLocator : LPCSTR -> "str"
; lpszAttributeName : LPCSTR optional -> "str"
; lpBuffer : BYTE* out -> "var"
; dwBufferLength : DWORD -> "int"
; lpdwCharactersReturned : DWORD* out -> "var"
; lpfnEnumerator : GOPHER_ATTRIBUTE_ENUMERATOR optional -> "sptr"
; dwContext : UINT_PTR optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global GopherGetAttributeA "GopherGetAttributeA" sptr, str, str, sptr, int, sptr, sptr, sptr
; res = GopherGetAttributeA(hConnect, lpszLocator, lpszAttributeName, varptr(lpBuffer), dwBufferLength, varptr(lpdwCharactersReturned), lpfnEnumerator, dwContext)
; hConnect : void* -> "sptr"
; lpszLocator : LPCSTR -> "str"
; lpszAttributeName : LPCSTR optional -> "str"
; lpBuffer : BYTE* out -> "sptr"
; dwBufferLength : DWORD -> "int"
; lpdwCharactersReturned : DWORD* out -> "sptr"
; lpfnEnumerator : GOPHER_ATTRIBUTE_ENUMERATOR optional -> "sptr"
; dwContext : UINT_PTR optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。