ParseURLA

関数

URLを解析しスキームなどの構成要素情報を取得する。

DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT ParseURLA(
    LPCSTR pcszURL,
    PARSEDURLA* ppu
);

パラメーター

名前	型	方向	説明
pcszURL	LPCSTR	in	解析対象の URL を含む null 終端文字列へのポインターです。
ppu	PARSEDURLA*	inout	解析結果を受け取る PARSEDURL 構造体へのポインターです。呼び出し側のアプリケーションは、ParseURL を呼び出す前に、構造体の cbSize メンバーに構造体のサイズを設定する必要があります。

戻り値の型: HRESULT

公式ドキュメント

URL の簡易的な解析を行います。(ANSI)

戻り値

型: HRESULT

成功した場合は S_OK を返し、それ以外の場合は COM エラーコードを返します。文字列を URL として解析できなかった場合、この関数は URL_E_INVALID_SYNTAX(Intshcut.h で定義)を返します。

解説(Remarks)

ParseURL による解析はかなり簡易的なものです。より高度な URL 解析を行うには、InternetCrackUrl を使用してください。

例

このサンプルコンソールアプリケーションは、ParseURL を使用していくつかの単純な URL を解析します。


#include <windows.h>
#include <shlwapi.h>
#include <stdio.h>
#include <tchar.h>

void sample(LPCTSTR pcszUrl)
{
    PARSEDURL pu;
    pu.cbSize = sizeof(pu);
    HRESULT hr = ParseURL(pcszUrl, &pu);
    _tprintf(TEXT("ParseURL(%s) returned 0x%08x\n"), pcszUrl, hr);
    if (SUCCEEDED(hr)) {
        _tprintf(TEXT("Protocol = %.*s\n"), pu.cchProtocol, pu.pszProtocol);
        _tprintf(TEXT("Suffix   = %.*s\n"), pu.cchSuffix, pu.pszSuffix);
        _tprintf(TEXT("Scheme   = %d\n"), pu.nScheme);
        _tprintf(TEXT("\n"));
    }
}

int __cdecl main()
{
    sample(TEXT("http://msdn.microsoft.com/vstudio/"));
    sample(TEXT("mailto:someone@example.com"));
    sample(TEXT("file://C:\\AUTOEXEC.BAT"));
    sample(TEXT("C:\\AUTOEXEC.BAT"));
    return 0;
}   

OUTPUT:
---------

ParseURL(http://msdn.microsoft.com/vstudio/) returned 0x00000000
Protocol = http
Suffix   = //msdn.microsoft.com/vstudio/
Scheme   = 2

ParseURL(mailto:someone@example.com) returned 0x00000000
Protocol = mailto
Suffix   = someone@example.com
Scheme   = 4

ParseURL(file://C:\AUTOEXEC.BAT) returned 0x00000000
Protocol = file
Suffix   = C:\AUTOEXEC.BAT
Scheme   = 9

ParseURL(C:\AUTOEXEC.BAT) returned 0x80041001

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT ParseURLA(
    LPCSTR pcszURL,
    PARSEDURLA* ppu
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int ParseURLA(
    [MarshalAs(UnmanagedType.LPStr)] string pcszURL,   // LPCSTR
    IntPtr ppu   // PARSEDURLA* in/out
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ParseURLA(
    <MarshalAs(UnmanagedType.LPStr)> pcszURL As String,   ' LPCSTR
    ppu As IntPtr   ' PARSEDURLA* in/out
) As Integer
End Function

' pcszURL : LPCSTR
' ppu : PARSEDURLA* in/out
Declare PtrSafe Function ParseURLA Lib "shlwapi" ( _
    ByVal pcszURL As String, _
    ByVal ppu As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ParseURLA = ctypes.windll.shlwapi.ParseURLA
ParseURLA.restype = ctypes.c_int
ParseURLA.argtypes = [
    wintypes.LPCSTR,  # pcszURL : LPCSTR
    ctypes.c_void_p,  # ppu : PARSEDURLA* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
ParseURLA = Fiddle::Function.new(
  lib['ParseURLA'],
  [
    Fiddle::TYPE_VOIDP,  # pcszURL : LPCSTR
    Fiddle::TYPE_VOIDP,  # ppu : PARSEDURLA* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn ParseURLA(
        pcszURL: *const u8,  // LPCSTR
        ppu: *mut PARSEDURLA  // PARSEDURLA* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern int ParseURLA([MarshalAs(UnmanagedType.LPStr)] string pcszURL, IntPtr ppu);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_ParseURLA' -Namespace Win32 -PassThru
# $api::ParseURLA(pcszURL, ppu)

#uselib "SHLWAPI.dll"
#func global ParseURLA "ParseURLA" sptr, sptr
; ParseURLA pcszURL, varptr(ppu)   ; 戻り値は stat
; pcszURL : LPCSTR -> "sptr"
; ppu : PARSEDURLA* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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