Win32 API 日本語リファレンス
ホームUI.Shell › UrlApplySchemeW

UrlApplySchemeW

関数
スキームのないURLに適切なスキームを補って付与する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

HRESULT UrlApplySchemeW(
    LPCWSTR pszIn,
    LPWSTR pszOut,
    DWORD* pcchOut,
    DWORD dwFlags
);

パラメーター

名前方向説明
pszInLPCWSTRinURL を含む、最大長 INTERNET_MAX_URL_LENGTH の null 終端文字列です。
pszOutLPWSTRoutバッファーへのポインターです。この関数が正常に終了すると、pszIn で指定された URL を標準の scheme://URL_string 形式に変換した null 終端文字列が格納されます。
pcchOutDWORD*inoutpszOut バッファー内の文字数を設定した値のアドレスです。関数が終了すると、この値は関数が成功したか E_POINTER を返したかによって変わります。その他の戻り値の場合、このパラメーターの値には意味がありません。
dwFlagsDWORDin

スキームの判定方法を指定するフラグです。次のフラグを組み合わせることができます。

URL_APPLY_DEFAULT

UrlApplyScheme がスキームを判定できない場合に、既定のスキームを適用します。既定のプレフィックスはレジストリに格納されていますが、通常は "http" です。

URL_APPLY_GUESSSCHEME

pszIn を調べてスキームの判定を試みます。

URL_APPLY_GUESSFILE

pszIn からファイル URL の判定を試みます。

URL_APPLY_FORCEAPPLY

UrlApplyScheme に対し、pszIn のスキームを強制的に判定させます。

- dwFlags.URL_APPLY_DEFAULT

UrlApplyScheme がスキームを判定できない場合に、既定のスキームを適用します。既定のプレフィックスはレジストリに格納されていますが、通常は "http" です。

- dwFlags.URL_APPLY_FORCEAPPLY

UrlApplyScheme に対し、pszIn のスキームを強制的に判定させます。

- dwFlags.URL_APPLY_GUESSFILE

pszIn からファイル URL の判定を試みます。

- dwFlags.URL_APPLY_GUESSSCHEME

pszIn を調べてスキームの判定を試みます。

戻り値の型: HRESULT

公式ドキュメント

指定された URL 文字列のスキームを判定し、適切なプレフィックスを付加した文字列を返します。(Unicode)

戻り値

型: HRESULT

標準的な COM の戻り値を返します。次の値が含まれます。

戻り値 説明
S_OK
スキームが判定されました。pszOut は、スキームのプレフィックスが付加された URL を含む文字列を指します。pcchOut の値には、終端の NULL 文字を含まない文字列の文字数が設定されます。
S_FALSE
エラーはありませんでしたが、プレフィックスは付加されませんでした。
E_POINTER
バッファーが小さすぎました。pcchOut の値には、終端の NULL 文字を含めてバッファーが格納可能でなければならない最小の文字数が設定されます。

解説(Remarks)

URL が有効なスキームを持つ場合、文字列は変更されません。ただし、2 文字以上の文字の後にコロンが続くほぼすべての組み合わせは、スキームとして解析されます。有効な文字には、"." などの一般的な句読点も含まれます。入力文字列がこの条件に当てはまる場合、UrlApplyScheme はそれを有効と見なし、スキームを適用しないことがあります。関数に URL へのスキーム適用を強制するには、dwFlagsURL_APPLY_FORCEAPPLY フラグと URL_APPLY_DEFAULT フラグを設定します。このフラグの組み合わせにより、関数は URL へのスキーム適用を強制されます。通常、関数は有効なスキームを判定できません。2 つ目のフラグは、有効なスキームを判定できない場合に、関数が URL へ既定のスキームを適用することを保証します。

メモ

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

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

各言語での呼び出し定義

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

HRESULT UrlApplySchemeW(
    LPCWSTR pszIn,
    LPWSTR pszOut,
    DWORD* pcchOut,
    DWORD dwFlags
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int UrlApplySchemeW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszIn,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszOut,   // LPWSTR out
    ref uint pcchOut,   // DWORD* in/out
    uint dwFlags   // DWORD
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function UrlApplySchemeW(
    <MarshalAs(UnmanagedType.LPWStr)> pszIn As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszOut As System.Text.StringBuilder,   ' LPWSTR out
    ByRef pcchOut As UInteger,   ' DWORD* in/out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' pszIn : LPCWSTR
' pszOut : LPWSTR out
' pcchOut : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function UrlApplySchemeW Lib "shlwapi" ( _
    ByVal pszIn As LongPtr, _
    ByVal pszOut As LongPtr, _
    ByRef pcchOut 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

UrlApplySchemeW = ctypes.windll.shlwapi.UrlApplySchemeW
UrlApplySchemeW.restype = ctypes.c_int
UrlApplySchemeW.argtypes = [
    wintypes.LPCWSTR,  # pszIn : LPCWSTR
    wintypes.LPWSTR,  # pszOut : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # pcchOut : DWORD* in/out
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
UrlApplySchemeW = Fiddle::Function.new(
  lib['UrlApplySchemeW'],
  [
    Fiddle::TYPE_VOIDP,  # pszIn : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszOut : LPWSTR out
    Fiddle::TYPE_VOIDP,  # pcchOut : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn UrlApplySchemeW(
        pszIn: *const u16,  // LPCWSTR
        pszOut: *mut u16,  // LPWSTR out
        pcchOut: *mut u32,  // DWORD* in/out
        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 UrlApplySchemeW([MarshalAs(UnmanagedType.LPWStr)] string pszIn, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszOut, ref uint pcchOut, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_UrlApplySchemeW' -Namespace Win32 -PassThru
# $api::UrlApplySchemeW(pszIn, pszOut, pcchOut, dwFlags)
#uselib "SHLWAPI.dll"
#func global UrlApplySchemeW "UrlApplySchemeW" wptr, wptr, wptr, wptr
; UrlApplySchemeW pszIn, varptr(pszOut), varptr(pcchOut), dwFlags   ; 戻り値は stat
; pszIn : LPCWSTR -> "wptr"
; pszOut : LPWSTR out -> "wptr"
; pcchOut : DWORD* in/out -> "wptr"
; dwFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global UrlApplySchemeW "UrlApplySchemeW" wstr, var, var, int
; res = UrlApplySchemeW(pszIn, pszOut, pcchOut, dwFlags)
; pszIn : LPCWSTR -> "wstr"
; pszOut : LPWSTR out -> "var"
; pcchOut : DWORD* in/out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT UrlApplySchemeW(LPCWSTR pszIn, LPWSTR pszOut, DWORD* pcchOut, DWORD dwFlags)
#uselib "SHLWAPI.dll"
#cfunc global UrlApplySchemeW "UrlApplySchemeW" wstr, var, var, int
; res = UrlApplySchemeW(pszIn, pszOut, pcchOut, dwFlags)
; pszIn : LPCWSTR -> "wstr"
; pszOut : LPWSTR out -> "var"
; pcchOut : DWORD* in/out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procUrlApplySchemeW = shlwapi.NewProc("UrlApplySchemeW")
)

// pszIn (LPCWSTR), pszOut (LPWSTR out), pcchOut (DWORD* in/out), dwFlags (DWORD)
r1, _, err := procUrlApplySchemeW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszIn))),
	uintptr(pszOut),
	uintptr(pcchOut),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function UrlApplySchemeW(
  pszIn: PWideChar;   // LPCWSTR
  pszOut: PWideChar;   // LPWSTR out
  pcchOut: Pointer;   // DWORD* in/out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'UrlApplySchemeW';
result := DllCall("SHLWAPI\UrlApplySchemeW"
    , "WStr", pszIn   ; LPCWSTR
    , "Ptr", pszOut   ; LPWSTR out
    , "Ptr", pcchOut   ; DWORD* in/out
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: HRESULT
●UrlApplySchemeW(pszIn, pszOut, pcchOut, dwFlags) = DLL("SHLWAPI.dll", "int UrlApplySchemeW(char*, char*, void*, dword)")
# 呼び出し: UrlApplySchemeW(pszIn, pszOut, pcchOut, dwFlags)
# pszIn : LPCWSTR -> "char*"
# pszOut : LPWSTR out -> "char*"
# pcchOut : DWORD* in/out -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shlwapi" fn UrlApplySchemeW(
    pszIn: [*c]const u16, // LPCWSTR
    pszOut: [*c]u16, // LPWSTR out
    pcchOut: [*c]u32, // DWORD* in/out
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc UrlApplySchemeW(
    pszIn: WideCString,  # LPCWSTR
    pszOut: ptr uint16,  # LPWSTR out
    pcchOut: ptr uint32,  # DWORD* in/out
    dwFlags: uint32  # DWORD
): int32 {.importc: "UrlApplySchemeW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
int UrlApplySchemeW(
    const(wchar)* pszIn,   // LPCWSTR
    wchar* pszOut,   // LPWSTR out
    uint* pcchOut,   // DWORD* in/out
    uint dwFlags   // DWORD
);
ccall((:UrlApplySchemeW, "SHLWAPI.dll"), stdcall, Int32,
      (Cwstring, Ptr{UInt16}, Ptr{UInt32}, UInt32),
      pszIn, pszOut, pcchOut, dwFlags)
# pszIn : LPCWSTR -> Cwstring
# pszOut : LPWSTR out -> Ptr{UInt16}
# pcchOut : DWORD* in/out -> Ptr{UInt32}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t UrlApplySchemeW(
    const uint16_t* pszIn,
    uint16_t* pszOut,
    uint32_t* pcchOut,
    uint32_t dwFlags);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.UrlApplySchemeW(pszIn, pszOut, pcchOut, dwFlags)
-- pszIn : LPCWSTR
-- pszOut : LPWSTR out
-- pcchOut : DWORD* in/out
-- 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 UrlApplySchemeW = lib.func('__stdcall', 'UrlApplySchemeW', 'int32_t', ['str16', 'uint16_t *', 'uint32_t *', 'uint32_t']);
// UrlApplySchemeW(pszIn, pszOut, pcchOut, dwFlags)
// pszIn : LPCWSTR -> 'str16'
// pszOut : LPWSTR out -> 'uint16_t *'
// pcchOut : DWORD* in/out -> 'uint32_t *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  UrlApplySchemeW: { parameters: ["buffer", "buffer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.UrlApplySchemeW(pszIn, pszOut, pcchOut, dwFlags)
// pszIn : LPCWSTR -> "buffer"
// pszOut : LPWSTR out -> "buffer"
// pcchOut : DWORD* in/out -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t UrlApplySchemeW(
    const uint16_t* pszIn,
    uint16_t* pszOut,
    uint32_t* pcchOut,
    uint32_t dwFlags);
C, "SHLWAPI.dll");
// $ffi->UrlApplySchemeW(pszIn, pszOut, pcchOut, dwFlags);
// pszIn : LPCWSTR
// pszOut : LPWSTR out
// pcchOut : DWORD* in/out
// 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 UrlApplySchemeW(
        WString pszIn,   // LPCWSTR
        char[] pszOut,   // LPWSTR out
        IntByReference pcchOut,   // DWORD* in/out
        int dwFlags   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun UrlApplySchemeW = UrlApplySchemeW(
    pszIn : UInt16*,   # LPCWSTR
    pszOut : UInt16*,   # LPWSTR out
    pcchOut : UInt32*,   # DWORD* in/out
    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 UrlApplySchemeWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint32>, Uint32);
typedef UrlApplySchemeWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint32>, int);
final UrlApplySchemeW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<UrlApplySchemeWNative, UrlApplySchemeWDart>('UrlApplySchemeW');
// pszIn : LPCWSTR -> Pointer<Utf16>
// pszOut : LPWSTR out -> Pointer<Utf16>
// pcchOut : DWORD* in/out -> Pointer<Uint32>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UrlApplySchemeW(
  pszIn: PWideChar;   // LPCWSTR
  pszOut: PWideChar;   // LPWSTR out
  pcchOut: Pointer;   // DWORD* in/out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'UrlApplySchemeW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UrlApplySchemeW"
  c_UrlApplySchemeW :: CWString -> CWString -> Ptr Word32 -> Word32 -> IO Int32
-- pszIn : LPCWSTR -> CWString
-- pszOut : LPWSTR out -> CWString
-- pcchOut : DWORD* in/out -> Ptr Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let urlapplyschemew =
  foreign "UrlApplySchemeW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr 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) *)
(* 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 ("UrlApplySchemeW" url-apply-scheme-w :convention :stdcall) :int32
  (psz-in (:string :encoding :utf-16le))   ; LPCWSTR
  (psz-out :pointer)   ; LPWSTR out
  (pcch-out :pointer)   ; DWORD* in/out
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UrlApplySchemeW = Win32::API::More->new('SHLWAPI',
    'int UrlApplySchemeW(LPCWSTR pszIn, LPWSTR pszOut, LPVOID pcchOut, DWORD dwFlags)');
# my $ret = $UrlApplySchemeW->Call($pszIn, $pszOut, $pcchOut, $dwFlags);
# pszIn : LPCWSTR -> LPCWSTR
# pszOut : LPWSTR out -> LPWSTR
# pcchOut : DWORD* in/out -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い