UrlGetPartW
関数URLからスキームやホストなど指定した構成要素を取り出す。
シグネチャ
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
HRESULT UrlGetPartW(
LPCWSTR pszIn,
LPWSTR pszOut,
DWORD* pcchOut,
DWORD dwPart,
DWORD dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszIn | LPCWSTR | in | URL を格納する、最大長 INTERNET_MAX_URL_LENGTH の null 終端文字列です。 |
| pszOut | LPWSTR | out | この関数が正常に終了したときに、URL の指定された部分を含む null 終端文字列を受け取るバッファへのポインターです。 |
| pcchOut | DWORD* | inout | 入力時に、pszOut バッファ内の文字数に設定される値へのポインターです。この関数が正常に終了すると、その値は関数が成功したか E_POINTER を返したかによって異なります。それ以外の戻り値の場合、このパラメーターの値に意味はありません。 |
| dwPart | DWORD | in | 取得する URL の部分を指定するフラグです。次のいずれかの値を指定できます。 URL_PART_HOSTNAMEホスト名。 URL_PART_PASSWORDパスワード。 URL_PART_PORTポート番号。 URL_PART_QUERYURL のクエリ部分。 URL_PART_SCHEMEURL スキーム。 URL_PART_USERNAMEユーザー名。 |
| dwFlags | DWORD | in | dwPart で指定された部分に加えて URL スキームを保持するために設定できるフラグです。 URL_PARTFLAG_KEEPSCHEMEURL スキームを保持します。 - dwFlags.URL_PARTFLAG_KEEPSCHEMEURL スキームを保持します。 - dwPart.URL_PART_HOSTNAMEホスト名。 - dwPart.URL_PART_PASSWORDパスワード。 - dwPart.URL_PART_PORTポート番号。 - dwPart.URL_PART_QUERYURL のクエリ部分。 - dwPart.URL_PART_SCHEMEURL スキーム。 - dwPart.URL_PART_USERNAMEユーザー名。 |
戻り値の型: HRESULT
公式ドキュメント
URL 文字列を受け取り、その URL の指定された部分を返します。(Unicode)
戻り値
型: HRESULT
成功した場合は S_OK を返します。pcchOut が指す値は、終端の NULL を除いた、出力バッファに書き込まれた文字数に設定されます。バッファが小さすぎた場合は E_POINTER が返され、pcchOut が指す値は、終端の NULL 文字を含む、バッファが格納できる必要のある最小文字数に設定されます。それ以外の場合は、COM エラー値が返されます。
解説(Remarks)
メモ
shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして UrlGetPart を定義します。エンコーディングに依存しないエイリアスの使用を、エンコーディングに依存しないわけではないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、関数プロトタイプの規則を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
HRESULT UrlGetPartW(
LPCWSTR pszIn,
LPWSTR pszOut,
DWORD* pcchOut,
DWORD dwPart,
DWORD dwFlags
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int UrlGetPartW(
[MarshalAs(UnmanagedType.LPWStr)] string pszIn, // LPCWSTR
[MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszOut, // LPWSTR out
ref uint pcchOut, // DWORD* in/out
uint dwPart, // DWORD
uint dwFlags // DWORD
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function UrlGetPartW(
<MarshalAs(UnmanagedType.LPWStr)> pszIn As String, ' LPCWSTR
<MarshalAs(UnmanagedType.LPWStr)> pszOut As System.Text.StringBuilder, ' LPWSTR out
ByRef pcchOut As UInteger, ' DWORD* in/out
dwPart As UInteger, ' DWORD
dwFlags As UInteger ' DWORD
) As Integer
End Function' pszIn : LPCWSTR
' pszOut : LPWSTR out
' pcchOut : DWORD* in/out
' dwPart : DWORD
' dwFlags : DWORD
Declare PtrSafe Function UrlGetPartW Lib "shlwapi" ( _
ByVal pszIn As LongPtr, _
ByVal pszOut As LongPtr, _
ByRef pcchOut As Long, _
ByVal dwPart As Long, _
ByVal dwFlags 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
UrlGetPartW = ctypes.windll.shlwapi.UrlGetPartW
UrlGetPartW.restype = ctypes.c_int
UrlGetPartW.argtypes = [
wintypes.LPCWSTR, # pszIn : LPCWSTR
wintypes.LPWSTR, # pszOut : LPWSTR out
ctypes.POINTER(wintypes.DWORD), # pcchOut : DWORD* in/out
wintypes.DWORD, # dwPart : DWORD
wintypes.DWORD, # dwFlags : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
UrlGetPartW = Fiddle::Function.new(
lib['UrlGetPartW'],
[
Fiddle::TYPE_VOIDP, # pszIn : LPCWSTR
Fiddle::TYPE_VOIDP, # pszOut : LPWSTR out
Fiddle::TYPE_VOIDP, # pcchOut : DWORD* in/out
-Fiddle::TYPE_INT, # dwPart : DWORD
-Fiddle::TYPE_INT, # dwFlags : DWORD
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "shlwapi")]
extern "system" {
fn UrlGetPartW(
pszIn: *const u16, // LPCWSTR
pszOut: *mut u16, // LPWSTR out
pcchOut: *mut u32, // DWORD* in/out
dwPart: u32, // DWORD
dwFlags: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern int UrlGetPartW([MarshalAs(UnmanagedType.LPWStr)] string pszIn, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszOut, ref uint pcchOut, uint dwPart, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_UrlGetPartW' -Namespace Win32 -PassThru
# $api::UrlGetPartW(pszIn, pszOut, pcchOut, dwPart, dwFlags)#uselib "SHLWAPI.dll"
#func global UrlGetPartW "UrlGetPartW" wptr, wptr, wptr, wptr, wptr
; UrlGetPartW pszIn, varptr(pszOut), varptr(pcchOut), dwPart, dwFlags ; 戻り値は stat
; pszIn : LPCWSTR -> "wptr"
; pszOut : LPWSTR out -> "wptr"
; pcchOut : DWORD* in/out -> "wptr"
; dwPart : DWORD -> "wptr"
; dwFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SHLWAPI.dll" #cfunc global UrlGetPartW "UrlGetPartW" wstr, var, var, int, int ; res = UrlGetPartW(pszIn, pszOut, pcchOut, dwPart, dwFlags) ; pszIn : LPCWSTR -> "wstr" ; pszOut : LPWSTR out -> "var" ; pcchOut : DWORD* in/out -> "var" ; dwPart : DWORD -> "int" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll" #cfunc global UrlGetPartW "UrlGetPartW" wstr, sptr, sptr, int, int ; res = UrlGetPartW(pszIn, varptr(pszOut), varptr(pcchOut), dwPart, dwFlags) ; pszIn : LPCWSTR -> "wstr" ; pszOut : LPWSTR out -> "sptr" ; pcchOut : DWORD* in/out -> "sptr" ; dwPart : DWORD -> "int" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; HRESULT UrlGetPartW(LPCWSTR pszIn, LPWSTR pszOut, DWORD* pcchOut, DWORD dwPart, DWORD dwFlags) #uselib "SHLWAPI.dll" #cfunc global UrlGetPartW "UrlGetPartW" wstr, var, var, int, int ; res = UrlGetPartW(pszIn, pszOut, pcchOut, dwPart, dwFlags) ; pszIn : LPCWSTR -> "wstr" ; pszOut : LPWSTR out -> "var" ; pcchOut : DWORD* in/out -> "var" ; dwPart : DWORD -> "int" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT UrlGetPartW(LPCWSTR pszIn, LPWSTR pszOut, DWORD* pcchOut, DWORD dwPart, DWORD dwFlags) #uselib "SHLWAPI.dll" #cfunc global UrlGetPartW "UrlGetPartW" wstr, intptr, intptr, int, int ; res = UrlGetPartW(pszIn, varptr(pszOut), varptr(pcchOut), dwPart, dwFlags) ; pszIn : LPCWSTR -> "wstr" ; pszOut : LPWSTR out -> "intptr" ; pcchOut : DWORD* in/out -> "intptr" ; dwPart : DWORD -> "int" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procUrlGetPartW = shlwapi.NewProc("UrlGetPartW")
)
// pszIn (LPCWSTR), pszOut (LPWSTR out), pcchOut (DWORD* in/out), dwPart (DWORD), dwFlags (DWORD)
r1, _, err := procUrlGetPartW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszIn))),
uintptr(pszOut),
uintptr(pcchOut),
uintptr(dwPart),
uintptr(dwFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction UrlGetPartW(
pszIn: PWideChar; // LPCWSTR
pszOut: PWideChar; // LPWSTR out
pcchOut: Pointer; // DWORD* in/out
dwPart: DWORD; // DWORD
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'SHLWAPI.dll' name 'UrlGetPartW';result := DllCall("SHLWAPI\UrlGetPartW"
, "WStr", pszIn ; LPCWSTR
, "Ptr", pszOut ; LPWSTR out
, "Ptr", pcchOut ; DWORD* in/out
, "UInt", dwPart ; DWORD
, "UInt", dwFlags ; DWORD
, "Int") ; return: HRESULT●UrlGetPartW(pszIn, pszOut, pcchOut, dwPart, dwFlags) = DLL("SHLWAPI.dll", "int UrlGetPartW(char*, char*, void*, dword, dword)")
# 呼び出し: UrlGetPartW(pszIn, pszOut, pcchOut, dwPart, dwFlags)
# pszIn : LPCWSTR -> "char*"
# pszOut : LPWSTR out -> "char*"
# pcchOut : DWORD* in/out -> "void*"
# dwPart : DWORD -> "dword"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "shlwapi" fn UrlGetPartW(
pszIn: [*c]const u16, // LPCWSTR
pszOut: [*c]u16, // LPWSTR out
pcchOut: [*c]u32, // DWORD* in/out
dwPart: u32, // DWORD
dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc UrlGetPartW(
pszIn: WideCString, # LPCWSTR
pszOut: ptr uint16, # LPWSTR out
pcchOut: ptr uint32, # DWORD* in/out
dwPart: uint32, # DWORD
dwFlags: uint32 # DWORD
): int32 {.importc: "UrlGetPartW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shlwapi");
extern(Windows)
int UrlGetPartW(
const(wchar)* pszIn, // LPCWSTR
wchar* pszOut, // LPWSTR out
uint* pcchOut, // DWORD* in/out
uint dwPart, // DWORD
uint dwFlags // DWORD
);ccall((:UrlGetPartW, "SHLWAPI.dll"), stdcall, Int32,
(Cwstring, Ptr{UInt16}, Ptr{UInt32}, UInt32, UInt32),
pszIn, pszOut, pcchOut, dwPart, dwFlags)
# pszIn : LPCWSTR -> Cwstring
# pszOut : LPWSTR out -> Ptr{UInt16}
# pcchOut : DWORD* in/out -> Ptr{UInt32}
# dwPart : DWORD -> UInt32
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t UrlGetPartW(
const uint16_t* pszIn,
uint16_t* pszOut,
uint32_t* pcchOut,
uint32_t dwPart,
uint32_t dwFlags);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.UrlGetPartW(pszIn, pszOut, pcchOut, dwPart, dwFlags)
-- pszIn : LPCWSTR
-- pszOut : LPWSTR out
-- pcchOut : DWORD* in/out
-- dwPart : DWORD
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const UrlGetPartW = lib.func('__stdcall', 'UrlGetPartW', 'int32_t', ['str16', 'uint16_t *', 'uint32_t *', 'uint32_t', 'uint32_t']);
// UrlGetPartW(pszIn, pszOut, pcchOut, dwPart, dwFlags)
// pszIn : LPCWSTR -> 'str16'
// pszOut : LPWSTR out -> 'uint16_t *'
// pcchOut : DWORD* in/out -> 'uint32_t *'
// dwPart : DWORD -> 'uint32_t'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
UrlGetPartW: { parameters: ["buffer", "buffer", "pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.UrlGetPartW(pszIn, pszOut, pcchOut, dwPart, dwFlags)
// pszIn : LPCWSTR -> "buffer"
// pszOut : LPWSTR out -> "buffer"
// pcchOut : DWORD* in/out -> "pointer"
// dwPart : DWORD -> "u32"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t UrlGetPartW(
const uint16_t* pszIn,
uint16_t* pszOut,
uint32_t* pcchOut,
uint32_t dwPart,
uint32_t dwFlags);
C, "SHLWAPI.dll");
// $ffi->UrlGetPartW(pszIn, pszOut, pcchOut, dwPart, dwFlags);
// pszIn : LPCWSTR
// pszOut : LPWSTR out
// pcchOut : DWORD* in/out
// dwPart : DWORD
// dwFlags : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Shlwapi extends StdCallLibrary {
Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.UNICODE_OPTIONS);
int UrlGetPartW(
WString pszIn, // LPCWSTR
char[] pszOut, // LPWSTR out
IntByReference pcchOut, // DWORD* in/out
int dwPart, // DWORD
int dwFlags // DWORD
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shlwapi")]
lib LibSHLWAPI
fun UrlGetPartW = UrlGetPartW(
pszIn : UInt16*, # LPCWSTR
pszOut : UInt16*, # LPWSTR out
pcchOut : UInt32*, # DWORD* in/out
dwPart : UInt32, # DWORD
dwFlags : UInt32 # DWORD
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef UrlGetPartWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint32>, Uint32, Uint32);
typedef UrlGetPartWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint32>, int, int);
final UrlGetPartW = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<UrlGetPartWNative, UrlGetPartWDart>('UrlGetPartW');
// pszIn : LPCWSTR -> Pointer<Utf16>
// pszOut : LPWSTR out -> Pointer<Utf16>
// pcchOut : DWORD* in/out -> Pointer<Uint32>
// dwPart : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function UrlGetPartW(
pszIn: PWideChar; // LPCWSTR
pszOut: PWideChar; // LPWSTR out
pcchOut: Pointer; // DWORD* in/out
dwPart: DWORD; // DWORD
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'SHLWAPI.dll' name 'UrlGetPartW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "UrlGetPartW"
c_UrlGetPartW :: CWString -> CWString -> Ptr Word32 -> Word32 -> Word32 -> IO Int32
-- pszIn : LPCWSTR -> CWString
-- pszOut : LPWSTR out -> CWString
-- pcchOut : DWORD* in/out -> Ptr Word32
-- dwPart : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let urlgetpartw =
foreign "UrlGetPartW"
((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint32_t) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* pszIn : LPCWSTR -> (ptr uint16_t) *)
(* pszOut : LPWSTR out -> (ptr uint16_t) *)
(* pcchOut : DWORD* in/out -> (ptr uint32_t) *)
(* dwPart : DWORD -> uint32_t *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)
(cffi:defcfun ("UrlGetPartW" url-get-part-w :convention :stdcall) :int32
(psz-in (:string :encoding :utf-16le)) ; LPCWSTR
(psz-out :pointer) ; LPWSTR out
(pcch-out :pointer) ; DWORD* in/out
(dw-part :uint32) ; DWORD
(dw-flags :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $UrlGetPartW = Win32::API::More->new('SHLWAPI',
'int UrlGetPartW(LPCWSTR pszIn, LPWSTR pszOut, LPVOID pcchOut, DWORD dwPart, DWORD dwFlags)');
# my $ret = $UrlGetPartW->Call($pszIn, $pszOut, $pcchOut, $dwPart, $dwFlags);
# pszIn : LPCWSTR -> LPCWSTR
# pszOut : LPWSTR out -> LPWSTR
# pcchOut : DWORD* in/out -> LPVOID
# dwPart : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f UrlGetPartA (ANSI版) — URLからスキームやホストなど指定した構成要素を取り出す。