ホーム › Networking.WinInet › GopherGetLocatorTypeW

GopherGetLocatorTypeW

関数

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

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

シグネチャ

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

BOOL GopherGetLocatorTypeW(
    LPCWSTR lpszLocator,
    DWORD* lpdwGopherType
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

成功した場合は 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 ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GopherGetLocatorType を定義します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、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 GopherGetLocatorTypeW(
    LPCWSTR lpszLocator,
    DWORD* lpdwGopherType
);

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

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

' lpszLocator : LPCWSTR
' lpdwGopherType : DWORD* out
Declare PtrSafe Function GopherGetLocatorTypeW Lib "wininet" ( _
    ByVal lpszLocator As LongPtr, _
    ByRef lpdwGopherType 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

GopherGetLocatorTypeW = ctypes.windll.wininet.GopherGetLocatorTypeW
GopherGetLocatorTypeW.restype = wintypes.BOOL
GopherGetLocatorTypeW.argtypes = [
    wintypes.LPCWSTR,  # lpszLocator : LPCWSTR
    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')
GopherGetLocatorTypeW = Fiddle::Function.new(
  lib['GopherGetLocatorTypeW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszLocator : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpdwGopherType : DWORD* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wininet")]
extern "system" {
    fn GopherGetLocatorTypeW(
        lpszLocator: *const u16,  // LPCWSTR
        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.Unicode, SetLastError = true)]
public static extern bool GopherGetLocatorTypeW([MarshalAs(UnmanagedType.LPWStr)] string lpszLocator, out uint lpdwGopherType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_GopherGetLocatorTypeW' -Namespace Win32 -PassThru
# $api::GopherGetLocatorTypeW(lpszLocator, lpdwGopherType)

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

出力引数:

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