ホーム › Networking.WinInet › GopherCreateLocatorA

GopherCreateLocatorA

関数

指定要素からGopherロケーター文字列を生成する(ANSI版)。

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

シグネチャ

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

BOOL GopherCreateLocatorA(
    LPCSTR lpszHost,
    WORD nServerPort,
    LPCSTR lpszDisplayString,   // optional
    LPCSTR lpszSelectorString,   // optional
    DWORD dwGopherType,
    LPSTR lpszLocator,   // optional
    DWORD* lpdwBufferLength
);

パラメーター

名前	型	方向	説明
lpszHost	LPCSTR	in	ホスト名、またはドット区切りの IP アドレス(198.105.232.1 など)を含む null 終端文字列へのポインターです。
nServerPort	WORD	in	lpszHost 上の Gopher サーバーが待ち受けるポート番号で、ホストバイトオーダーで指定します。 nServerPort が INTERNET_INVALID_PORT_NUMBER の場合は、既定の Gopher ポートが使用されます。
lpszDisplayString	LPCSTR	inoptional	表示する Gopher ドキュメントまたはディレクトリを含む null 終端文字列へのポインターです。このパラメーターが NULL の場合、関数は Gopher サーバーの既定のディレクトリを返します。
lpszSelectorString	LPCSTR	inoptional	情報を取得するために Gopher サーバーへ送信するセレクター文字列へのポインターです。このパラメーターは NULL でもかまいません。
dwGopherType	DWORD	in	lpszSelectorString がディレクトリとドキュメントのいずれを指すか、また要求が Gopher+ と Gopher のいずれであるかを決定します。 dwGopherType の値が 0 の場合は、既定値の GOPHER_TYPE_DIRECTORY が使用されます。これは gopher type values のいずれか 1 つを指定できます。
lpszLocator	LPSTR	outoptional	ロケーター文字列を受け取るバッファーへのポインターです。 lpszLocator が NULL の場合、 lpdwBufferLength が必要なバッファー長を受け取りますが、関数はそれ以外の処理を行いません。
lpdwBufferLength	DWORD*	inout	lpszLocator バッファーの長さ(文字数)を格納する変数へのポインターです。関数が戻ると、このパラメーターはバッファーに書き込まれた文字数を受け取ります。 GetLastError が ERROR_INSUFFICIENT_BUFFER を返す場合、このパラメーターは必要な文字数を受け取ります。

戻り値の型: BOOL

公式ドキュメント

セレクター文字列の構成要素から Gopher または Gopher+ のロケーター文字列を作成します。(ANSI)

戻り値

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

解説(Remarks)

Gopher サーバーから情報を取得するには、アプリケーションはまず Gopher サーバーから Gopher の「ロケーター」を取得する必要があります。

ロケーターは、アプリケーションが不透明なトークンとして扱うべきものであり、通常は特定の情報を取得するための GopherFindFirstFile 関数の呼び出しに使用されます。

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

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

メモ

wininet.h ヘッダーは GopherCreateLocator を、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 GopherCreateLocatorA(
    LPCSTR lpszHost,
    WORD nServerPort,
    LPCSTR lpszDisplayString,   // optional
    LPCSTR lpszSelectorString,   // optional
    DWORD dwGopherType,
    LPSTR lpszLocator,   // optional
    DWORD* lpdwBufferLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GopherCreateLocatorA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszHost,   // LPCSTR
    ushort nServerPort,   // WORD
    [MarshalAs(UnmanagedType.LPStr)] string lpszDisplayString,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpszSelectorString,   // LPCSTR optional
    uint dwGopherType,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszLocator,   // LPSTR optional, out
    ref uint lpdwBufferLength   // DWORD* in/out
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GopherCreateLocatorA(
    <MarshalAs(UnmanagedType.LPStr)> lpszHost As String,   ' LPCSTR
    nServerPort As UShort,   ' WORD
    <MarshalAs(UnmanagedType.LPStr)> lpszDisplayString As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpszSelectorString As String,   ' LPCSTR optional
    dwGopherType As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpszLocator As System.Text.StringBuilder,   ' LPSTR optional, out
    ByRef lpdwBufferLength As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszHost : LPCSTR
' nServerPort : WORD
' lpszDisplayString : LPCSTR optional
' lpszSelectorString : LPCSTR optional
' dwGopherType : DWORD
' lpszLocator : LPSTR optional, out
' lpdwBufferLength : DWORD* in/out
Declare PtrSafe Function GopherCreateLocatorA Lib "wininet" ( _
    ByVal lpszHost As String, _
    ByVal nServerPort As Integer, _
    ByVal lpszDisplayString As String, _
    ByVal lpszSelectorString As String, _
    ByVal dwGopherType As Long, _
    ByVal lpszLocator 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

GopherCreateLocatorA = ctypes.windll.wininet.GopherCreateLocatorA
GopherCreateLocatorA.restype = wintypes.BOOL
GopherCreateLocatorA.argtypes = [
    wintypes.LPCSTR,  # lpszHost : LPCSTR
    ctypes.c_ushort,  # nServerPort : WORD
    wintypes.LPCSTR,  # lpszDisplayString : LPCSTR optional
    wintypes.LPCSTR,  # lpszSelectorString : LPCSTR optional
    wintypes.DWORD,  # dwGopherType : DWORD
    wintypes.LPSTR,  # lpszLocator : 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')
GopherCreateLocatorA = Fiddle::Function.new(
  lib['GopherCreateLocatorA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszHost : LPCSTR
    -Fiddle::TYPE_SHORT,  # nServerPort : WORD
    Fiddle::TYPE_VOIDP,  # lpszDisplayString : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpszSelectorString : LPCSTR optional
    -Fiddle::TYPE_INT,  # dwGopherType : DWORD
    Fiddle::TYPE_VOIDP,  # lpszLocator : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpdwBufferLength : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn GopherCreateLocatorA(
        lpszHost: *const u8,  // LPCSTR
        nServerPort: u16,  // WORD
        lpszDisplayString: *const u8,  // LPCSTR optional
        lpszSelectorString: *const u8,  // LPCSTR optional
        dwGopherType: u32,  // DWORD
        lpszLocator: *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 GopherCreateLocatorA([MarshalAs(UnmanagedType.LPStr)] string lpszHost, ushort nServerPort, [MarshalAs(UnmanagedType.LPStr)] string lpszDisplayString, [MarshalAs(UnmanagedType.LPStr)] string lpszSelectorString, uint dwGopherType, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszLocator, ref uint lpdwBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_GopherCreateLocatorA' -Namespace Win32 -PassThru
# $api::GopherCreateLocatorA(lpszHost, nServerPort, lpszDisplayString, lpszSelectorString, dwGopherType, lpszLocator, lpdwBufferLength)

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

出力引数:

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