ホーム › Networking.WinInet › InternetCreateUrlA

InternetCreateUrlA

関数

URL構成要素から完全なURL文字列を生成する(ANSI)。

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

シグネチャ

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

BOOL InternetCreateUrlA(
    URL_COMPONENTSA* lpUrlComponents,
    DWORD dwFlags,
    LPSTR lpszUrl,   // optional
    DWORD* lpdwUrlLength
);

パラメーター

名前

型

方向

説明

lpUrlComponents

URL_COMPONENTSA*

URL の作成元となる構成要素を格納した URL_COMPONENTS 構造体へのポインターです。

dwFlags

DWORD

この関数の動作を制御します。このパラメーターには、次の値のうち 1 つ以上を指定できます。

値

意味

ICU_ESCAPE

lpUrlComponents パラメーターが指す URL_COMPONENTS 構造体の lpszUrlPath メンバーが指すパス文字列、および lpszExtraInfo メンバーが指す追加情報文字列の中で、すべての安全でない文字を対応するエスケープシーケンスに変換します。

Unicode 版の InternetCreateUrl は、最初にシステムコードページを使用して変換を試みます。それが失敗した場合は UTF-8 にフォールバックします。

ICU_USERNAME

廃止済み — 無視されます。

lpszUrl

LPSTR

outoptional

URL を受け取るバッファーへのポインターです。

lpdwUrlLength

DWORD*

inout

lpszUrl URL バッファーのサイズを TCHAR 単位で指定する変数へのポインターです。関数が返るとき、このパラメーターには NULL 終端文字を除いた URL 文字列のサイズが格納されます。 GetLastError が ERROR_INSUFFICIENT_BUFFER を返した場合、このパラメーターには作成された URL を格納するために必要なバイト数が格納されます。

戻り値の型: BOOL

公式ドキュメント

構成要素から URL を作成します。(ANSI)

戻り値

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

解説(Remarks)

lpUrlComponents に渡す URL_COMPONENTS 構造体でスキームを指定する場合、lpszScheme が NULL でなければそれがスキームとして使用されます。lpszScheme が NULL の場合は、nScheme に必要な INTERNET_SCHEME または INTERNET_SCHEME_DEFAULT を設定することにより、INTERNET_SCHEME 列挙体を使用してスキームを指定できます。

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

メモ

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

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool InternetCreateUrlA(
    IntPtr lpUrlComponents,   // URL_COMPONENTSA*
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszUrl,   // LPSTR optional, out
    ref uint lpdwUrlLength   // DWORD* in/out
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetCreateUrlA(
    lpUrlComponents As IntPtr,   ' URL_COMPONENTSA*
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpszUrl As System.Text.StringBuilder,   ' LPSTR optional, out
    ByRef lpdwUrlLength As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

InternetCreateUrlA = ctypes.windll.wininet.InternetCreateUrlA
InternetCreateUrlA.restype = wintypes.BOOL
InternetCreateUrlA.argtypes = [
    ctypes.c_void_p,  # lpUrlComponents : URL_COMPONENTSA*
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPSTR,  # lpszUrl : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpdwUrlLength : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetCreateUrlA = Fiddle::Function.new(
  lib['InternetCreateUrlA'],
  [
    Fiddle::TYPE_VOIDP,  # lpUrlComponents : URL_COMPONENTSA*
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpszUrl : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpdwUrlLength : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn InternetCreateUrlA(
        lpUrlComponents: *mut URL_COMPONENTSA,  // URL_COMPONENTSA*
        dwFlags: u32,  // DWORD
        lpszUrl: *mut u8,  // LPSTR optional, out
        lpdwUrlLength: *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 InternetCreateUrlA(IntPtr lpUrlComponents, uint dwFlags, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszUrl, ref uint lpdwUrlLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetCreateUrlA' -Namespace Win32 -PassThru
# $api::InternetCreateUrlA(lpUrlComponents, dwFlags, lpszUrl, lpdwUrlLength)

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

出力引数:

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