UrlGetPartA
関数URLからスキームやホストなど指定した構成要素を取り出す。
シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
HRESULT UrlGetPartA(
LPCSTR pszIn,
LPSTR pszOut,
DWORD* pcchOut,
DWORD dwPart,
DWORD dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszIn | LPCSTR | in | URL を格納した、最大長 INTERNET_MAX_URL_LENGTH の null 終端文字列です。 |
| pszOut | LPSTR | 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 スキームを保持します。 |
戻り値の型: HRESULT
公式ドキュメント
URL 文字列を受け取り、その URL の指定された部分を返します。(ANSI)
戻り値
型: HRESULT
成功した場合は S_OK を返します。pcchOut が指す値には、終端の NULL を除いた、出力バッファーに書き込まれた文字数が設定されます。バッファーが小さすぎた場合は E_POINTER が返され、pcchOut が指す値には、終端の NULL 文字を含め、バッファーが格納できる必要のある最小文字数が設定されます。それ以外の場合は、COM エラー値が返されます。
解説(Remarks)
メモ
shlwapi.h ヘッダーは UrlGetPart をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版が自動的に選択されます。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が発生し、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、「関数プロトタイプの規約」を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 (ANSI / -A)
#include <windows.h>
HRESULT UrlGetPartA(
LPCSTR pszIn,
LPSTR pszOut,
DWORD* pcchOut,
DWORD dwPart,
DWORD dwFlags
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int UrlGetPartA(
[MarshalAs(UnmanagedType.LPStr)] string pszIn, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszOut, // LPSTR out
ref uint pcchOut, // DWORD* in/out
uint dwPart, // DWORD
uint dwFlags // DWORD
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function UrlGetPartA(
<MarshalAs(UnmanagedType.LPStr)> pszIn As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> pszOut As System.Text.StringBuilder, ' LPSTR out
ByRef pcchOut As UInteger, ' DWORD* in/out
dwPart As UInteger, ' DWORD
dwFlags As UInteger ' DWORD
) As Integer
End Function' pszIn : LPCSTR
' pszOut : LPSTR out
' pcchOut : DWORD* in/out
' dwPart : DWORD
' dwFlags : DWORD
Declare PtrSafe Function UrlGetPartA Lib "shlwapi" ( _
ByVal pszIn As String, _
ByVal pszOut As String, _
ByRef pcchOut As Long, _
ByVal dwPart As Long, _
ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
UrlGetPartA = ctypes.windll.shlwapi.UrlGetPartA
UrlGetPartA.restype = ctypes.c_int
UrlGetPartA.argtypes = [
wintypes.LPCSTR, # pszIn : LPCSTR
wintypes.LPSTR, # pszOut : LPSTR 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')
UrlGetPartA = Fiddle::Function.new(
lib['UrlGetPartA'],
[
Fiddle::TYPE_VOIDP, # pszIn : LPCSTR
Fiddle::TYPE_VOIDP, # pszOut : LPSTR out
Fiddle::TYPE_VOIDP, # pcchOut : DWORD* in/out
-Fiddle::TYPE_INT, # dwPart : DWORD
-Fiddle::TYPE_INT, # dwFlags : DWORD
],
Fiddle::TYPE_INT)#[link(name = "shlwapi")]
extern "system" {
fn UrlGetPartA(
pszIn: *const u8, // LPCSTR
pszOut: *mut u8, // LPSTR 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.Ansi)]
public static extern int UrlGetPartA([MarshalAs(UnmanagedType.LPStr)] string pszIn, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszOut, ref uint pcchOut, uint dwPart, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_UrlGetPartA' -Namespace Win32 -PassThru
# $api::UrlGetPartA(pszIn, pszOut, pcchOut, dwPart, dwFlags)#uselib "SHLWAPI.dll"
#func global UrlGetPartA "UrlGetPartA" sptr, sptr, sptr, sptr, sptr
; UrlGetPartA pszIn, varptr(pszOut), varptr(pcchOut), dwPart, dwFlags ; 戻り値は stat
; pszIn : LPCSTR -> "sptr"
; pszOut : LPSTR out -> "sptr"
; pcchOut : DWORD* in/out -> "sptr"
; dwPart : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SHLWAPI.dll" #cfunc global UrlGetPartA "UrlGetPartA" str, var, var, int, int ; res = UrlGetPartA(pszIn, pszOut, pcchOut, dwPart, dwFlags) ; pszIn : LPCSTR -> "str" ; pszOut : LPSTR out -> "var" ; pcchOut : DWORD* in/out -> "var" ; dwPart : DWORD -> "int" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll" #cfunc global UrlGetPartA "UrlGetPartA" str, sptr, sptr, int, int ; res = UrlGetPartA(pszIn, varptr(pszOut), varptr(pcchOut), dwPart, dwFlags) ; pszIn : LPCSTR -> "str" ; pszOut : LPSTR out -> "sptr" ; pcchOut : DWORD* in/out -> "sptr" ; dwPart : DWORD -> "int" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; HRESULT UrlGetPartA(LPCSTR pszIn, LPSTR pszOut, DWORD* pcchOut, DWORD dwPart, DWORD dwFlags) #uselib "SHLWAPI.dll" #cfunc global UrlGetPartA "UrlGetPartA" str, var, var, int, int ; res = UrlGetPartA(pszIn, pszOut, pcchOut, dwPart, dwFlags) ; pszIn : LPCSTR -> "str" ; pszOut : LPSTR out -> "var" ; pcchOut : DWORD* in/out -> "var" ; dwPart : DWORD -> "int" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT UrlGetPartA(LPCSTR pszIn, LPSTR pszOut, DWORD* pcchOut, DWORD dwPart, DWORD dwFlags) #uselib "SHLWAPI.dll" #cfunc global UrlGetPartA "UrlGetPartA" str, intptr, intptr, int, int ; res = UrlGetPartA(pszIn, varptr(pszOut), varptr(pcchOut), dwPart, dwFlags) ; pszIn : LPCSTR -> "str" ; pszOut : LPSTR 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")
procUrlGetPartA = shlwapi.NewProc("UrlGetPartA")
)
// pszIn (LPCSTR), pszOut (LPSTR out), pcchOut (DWORD* in/out), dwPart (DWORD), dwFlags (DWORD)
r1, _, err := procUrlGetPartA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszIn))),
uintptr(pszOut),
uintptr(pcchOut),
uintptr(dwPart),
uintptr(dwFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction UrlGetPartA(
pszIn: PAnsiChar; // LPCSTR
pszOut: PAnsiChar; // LPSTR out
pcchOut: Pointer; // DWORD* in/out
dwPart: DWORD; // DWORD
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'SHLWAPI.dll' name 'UrlGetPartA';result := DllCall("SHLWAPI\UrlGetPartA"
, "AStr", pszIn ; LPCSTR
, "Ptr", pszOut ; LPSTR out
, "Ptr", pcchOut ; DWORD* in/out
, "UInt", dwPart ; DWORD
, "UInt", dwFlags ; DWORD
, "Int") ; return: HRESULT●UrlGetPartA(pszIn, pszOut, pcchOut, dwPart, dwFlags) = DLL("SHLWAPI.dll", "int UrlGetPartA(char*, char*, void*, dword, dword)")
# 呼び出し: UrlGetPartA(pszIn, pszOut, pcchOut, dwPart, dwFlags)
# pszIn : LPCSTR -> "char*"
# pszOut : LPSTR out -> "char*"
# pcchOut : DWORD* in/out -> "void*"
# dwPart : DWORD -> "dword"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn UrlGetPartA(
pszIn: [*c]const u8, // LPCSTR
pszOut: [*c]u8, // LPSTR out
pcchOut: [*c]u32, // DWORD* in/out
dwPart: u32, // DWORD
dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc UrlGetPartA(
pszIn: cstring, # LPCSTR
pszOut: ptr char, # LPSTR out
pcchOut: ptr uint32, # DWORD* in/out
dwPart: uint32, # DWORD
dwFlags: uint32 # DWORD
): int32 {.importc: "UrlGetPartA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
int UrlGetPartA(
const(char)* pszIn, // LPCSTR
char* pszOut, // LPSTR out
uint* pcchOut, // DWORD* in/out
uint dwPart, // DWORD
uint dwFlags // DWORD
);ccall((:UrlGetPartA, "SHLWAPI.dll"), stdcall, Int32,
(Cstring, Ptr{UInt8}, Ptr{UInt32}, UInt32, UInt32),
pszIn, pszOut, pcchOut, dwPart, dwFlags)
# pszIn : LPCSTR -> Cstring
# pszOut : LPSTR out -> Ptr{UInt8}
# pcchOut : DWORD* in/out -> Ptr{UInt32}
# dwPart : DWORD -> UInt32
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t UrlGetPartA(
const char* pszIn,
char* pszOut,
uint32_t* pcchOut,
uint32_t dwPart,
uint32_t dwFlags);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.UrlGetPartA(pszIn, pszOut, pcchOut, dwPart, dwFlags)
-- pszIn : LPCSTR
-- pszOut : LPSTR out
-- pcchOut : DWORD* in/out
-- dwPart : DWORD
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const UrlGetPartA = lib.func('__stdcall', 'UrlGetPartA', 'int32_t', ['str', 'char *', 'uint32_t *', 'uint32_t', 'uint32_t']);
// UrlGetPartA(pszIn, pszOut, pcchOut, dwPart, dwFlags)
// pszIn : LPCSTR -> 'str'
// pszOut : LPSTR out -> 'char *'
// pcchOut : DWORD* in/out -> 'uint32_t *'
// dwPart : DWORD -> 'uint32_t'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
UrlGetPartA: { parameters: ["buffer", "buffer", "pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.UrlGetPartA(pszIn, pszOut, pcchOut, dwPart, dwFlags)
// pszIn : LPCSTR -> "buffer"
// pszOut : LPSTR out -> "buffer"
// pcchOut : DWORD* in/out -> "pointer"
// dwPart : DWORD -> "u32"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t UrlGetPartA(
const char* pszIn,
char* pszOut,
uint32_t* pcchOut,
uint32_t dwPart,
uint32_t dwFlags);
C, "SHLWAPI.dll");
// $ffi->UrlGetPartA(pszIn, pszOut, pcchOut, dwPart, dwFlags);
// pszIn : LPCSTR
// pszOut : LPSTR 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.ASCII_OPTIONS);
int UrlGetPartA(
String pszIn, // LPCSTR
byte[] pszOut, // LPSTR out
IntByReference pcchOut, // DWORD* in/out
int dwPart, // DWORD
int dwFlags // DWORD
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun UrlGetPartA = UrlGetPartA(
pszIn : UInt8*, # LPCSTR
pszOut : UInt8*, # LPSTR 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 UrlGetPartANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>, Uint32, Uint32);
typedef UrlGetPartADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>, int, int);
final UrlGetPartA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<UrlGetPartANative, UrlGetPartADart>('UrlGetPartA');
// pszIn : LPCSTR -> Pointer<Utf8>
// pszOut : LPSTR out -> Pointer<Utf8>
// pcchOut : DWORD* in/out -> Pointer<Uint32>
// dwPart : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function UrlGetPartA(
pszIn: PAnsiChar; // LPCSTR
pszOut: PAnsiChar; // LPSTR out
pcchOut: Pointer; // DWORD* in/out
dwPart: DWORD; // DWORD
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'SHLWAPI.dll' name 'UrlGetPartA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "UrlGetPartA"
c_UrlGetPartA :: CString -> CString -> Ptr Word32 -> Word32 -> Word32 -> IO Int32
-- pszIn : LPCSTR -> CString
-- pszOut : LPSTR out -> CString
-- pcchOut : DWORD* in/out -> Ptr Word32
-- dwPart : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let urlgetparta =
foreign "UrlGetPartA"
(string @-> string @-> (ptr uint32_t) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* pszIn : LPCSTR -> string *)
(* pszOut : LPSTR out -> string *)
(* 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 ("UrlGetPartA" url-get-part-a :convention :stdcall) :int32
(psz-in :string) ; LPCSTR
(psz-out :pointer) ; LPSTR 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 $UrlGetPartA = Win32::API::More->new('SHLWAPI',
'int UrlGetPartA(LPCSTR pszIn, LPSTR pszOut, LPVOID pcchOut, DWORD dwPart, DWORD dwFlags)');
# my $ret = $UrlGetPartA->Call($pszIn, $pszOut, $pcchOut, $dwPart, $dwFlags);
# pszIn : LPCSTR -> LPCSTR
# pszOut : LPSTR out -> LPSTR
# pcchOut : DWORD* in/out -> LPVOID
# dwPart : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f UrlGetPartW (Unicode版) — URLからスキームやホストなど指定した構成要素を取り出す。