ホーム › Networking.WinInet › GopherGetLocatorTypeA

GopherGetLocatorTypeA

関数

Gopherロケーターの種類を解析して取得する(ANSI版)。

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

シグネチャ

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

BOOL GopherGetLocatorTypeA(
    LPCSTR lpszLocator,
    DWORD* lpdwGopherType
);

パラメーター

名前	型	方向	説明
lpszLocator	LPCSTR	in	解析する Gopher ロケーターを指定する、null で終わる文字列へのポインター。
lpdwGopherType	DWORD*	out	ロケーターの種類を受け取る変数へのポインター。種類は、 gopher type values の組み合わせから成るビットマスクです。

戻り値の型: BOOL

公式ドキュメント

Gopher ロケーターを解析し、その属性を判別します。(ANSI)

戻り値

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

解説(Remarks)

GopherGetLocatorType は、Gopher ロケーターが参照する項目に関する情報を返します。1 つのファイルに複数の属性が設定される場合があることに注意してください。たとえば、Gopher+ サーバーに格納されたテキストファイルには、GOPHER_TYPE_TEXT_FILE と GOPHER_TYPE_GOPHER_PLUS の両方が設定されます。

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

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

メモ

wininet.h ヘッダーは、GopherGetLocatorType を、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  (ANSI / -A)
#include <windows.h>

BOOL GopherGetLocatorTypeA(
    LPCSTR lpszLocator,
    DWORD* lpdwGopherType
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GopherGetLocatorTypeA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszLocator,   // LPCSTR
    out uint lpdwGopherType   // DWORD* out
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GopherGetLocatorTypeA(
    <MarshalAs(UnmanagedType.LPStr)> lpszLocator As String,   ' LPCSTR
    <Out> ByRef lpdwGopherType As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszLocator : LPCSTR
' lpdwGopherType : DWORD* out
Declare PtrSafe Function GopherGetLocatorTypeA Lib "wininet" ( _
    ByVal lpszLocator As String, _
    ByRef lpdwGopherType As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GopherGetLocatorTypeA = ctypes.windll.wininet.GopherGetLocatorTypeA
GopherGetLocatorTypeA.restype = wintypes.BOOL
GopherGetLocatorTypeA.argtypes = [
    wintypes.LPCSTR,  # lpszLocator : LPCSTR
    ctypes.POINTER(wintypes.DWORD),  # lpdwGopherType : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
GopherGetLocatorTypeA = Fiddle::Function.new(
  lib['GopherGetLocatorTypeA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszLocator : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpdwGopherType : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn GopherGetLocatorTypeA(
        lpszLocator: *const u8,  // LPCSTR
        lpdwGopherType: *mut u32  // DWORD* 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 GopherGetLocatorTypeA([MarshalAs(UnmanagedType.LPStr)] string lpszLocator, out uint lpdwGopherType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_GopherGetLocatorTypeA' -Namespace Win32 -PassThru
# $api::GopherGetLocatorTypeA(lpszLocator, lpdwGopherType)

#uselib "WININET.dll"
#func global GopherGetLocatorTypeA "GopherGetLocatorTypeA" sptr, sptr
; GopherGetLocatorTypeA lpszLocator, varptr(lpdwGopherType)   ; 戻り値は stat
; lpszLocator : LPCSTR -> "sptr"
; lpdwGopherType : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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