UrlApplySchemeA
関数シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
HRESULT UrlApplySchemeA(
LPCSTR pszIn,
LPSTR pszOut,
DWORD* pcchOut,
DWORD dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszIn | LPCSTR | in | URL を格納した、最大長 INTERNET_MAX_URL_LENGTH の null 終端文字列です。 |
| pszOut | LPSTR | out | この関数が成功して返るときに、pszIn で指定された URL を標準の scheme://URL_string 形式に変換した null 終端文字列を受け取るバッファーへのポインターです。 |
| pcchOut | DWORD* | inout | pszOut バッファー内の文字数が設定される値のアドレスです。関数が返るとき、その値は関数が成功したか E_POINTER を返したかによって異なります。それ以外の戻り値の場合、このパラメーターの値に意味はありません。 |
| dwFlags | DWORD | in | スキームの判定方法を指定するフラグです。次のフラグを組み合わせることができます。 URL_APPLY_DEFAULTUrlApplyScheme がスキームを判定できない場合に既定のスキームを適用します。既定のプレフィックスはレジストリに格納されていますが、通常は "http" です。 URL_APPLY_GUESSSCHEMEpszIn を調べてスキームの判定を試みます。 URL_APPLY_GUESSFILEpszIn からファイル URL の判定を試みます。 URL_APPLY_FORCEAPPLYUrlApplyScheme に pszIn のスキームを強制的に判定させます。 |
戻り値の型: HRESULT
公式ドキュメント
指定された URL 文字列のスキームを判定し、適切なプレフィックスを付加した文字列を返します。(ANSI)
戻り値
型: HRESULT
次の値を含む、標準的な COM の戻り値を返します。
| 戻り値 | 説明 |
|---|---|
| スキームが判定されました。pszOut は、スキームのプレフィックスが付いた URL を含む文字列を指します。pcchOut の値には、終端の NULL 文字を含まない文字列の文字数が設定されます。 | |
| エラーはありませんでしたが、プレフィックスは付加されませんでした。 | |
| バッファーが小さすぎました。pcchOut の値には、終端の NULL 文字を含めて、バッファーが格納できる必要のある最小の文字数が設定されます。 |
解説(Remarks)
URL に有効なスキームがある場合、文字列は変更されません。ただし、2 文字以上の文字の後にコロンが続くほぼあらゆる組み合わせがスキームとして解析されます。有効な文字には、"." などの一般的な記号も含まれます。入力文字列がこの条件に当てはまる場合、UrlApplyScheme はそれを有効とみなしてスキームを適用しないことがあります。URL にスキームを強制的に適用させるには、dwFlags に URL_APPLY_FORCEAPPLY フラグと URL_APPLY_DEFAULT フラグを設定します。このフラグの組み合わせにより、関数は URL にスキームを強制的に適用します。通常、関数は有効なスキームを判定できません。2 つ目のフラグは、有効なスキームを判定できない場合に、関数が URL に既定のスキームを適用することを保証します。
shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして UrlApplyScheme を定義します。エンコード中立のエイリアスの使用を、エンコード中立でないコードと混在させると、コンパイルエラーや実行時エラーの原因となる不整合が生じることがあります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
HRESULT UrlApplySchemeA(
LPCSTR pszIn,
LPSTR pszOut,
DWORD* pcchOut,
DWORD dwFlags
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int UrlApplySchemeA(
[MarshalAs(UnmanagedType.LPStr)] string pszIn, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszOut, // LPSTR out
ref uint pcchOut, // DWORD* in/out
uint dwFlags // DWORD
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function UrlApplySchemeA(
<MarshalAs(UnmanagedType.LPStr)> pszIn As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> pszOut As System.Text.StringBuilder, ' LPSTR out
ByRef pcchOut As UInteger, ' DWORD* in/out
dwFlags As UInteger ' DWORD
) As Integer
End Function' pszIn : LPCSTR
' pszOut : LPSTR out
' pcchOut : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function UrlApplySchemeA Lib "shlwapi" ( _
ByVal pszIn As String, _
ByVal pszOut As String, _
ByRef pcchOut 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
UrlApplySchemeA = ctypes.windll.shlwapi.UrlApplySchemeA
UrlApplySchemeA.restype = ctypes.c_int
UrlApplySchemeA.argtypes = [
wintypes.LPCSTR, # pszIn : LPCSTR
wintypes.LPSTR, # pszOut : LPSTR out
ctypes.POINTER(wintypes.DWORD), # pcchOut : DWORD* in/out
wintypes.DWORD, # dwFlags : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
UrlApplySchemeA = Fiddle::Function.new(
lib['UrlApplySchemeA'],
[
Fiddle::TYPE_VOIDP, # pszIn : LPCSTR
Fiddle::TYPE_VOIDP, # pszOut : LPSTR out
Fiddle::TYPE_VOIDP, # pcchOut : DWORD* in/out
-Fiddle::TYPE_INT, # dwFlags : DWORD
],
Fiddle::TYPE_INT)#[link(name = "shlwapi")]
extern "system" {
fn UrlApplySchemeA(
pszIn: *const u8, // LPCSTR
pszOut: *mut u8, // LPSTR 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.Ansi)]
public static extern int UrlApplySchemeA([MarshalAs(UnmanagedType.LPStr)] string pszIn, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszOut, ref uint pcchOut, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_UrlApplySchemeA' -Namespace Win32 -PassThru
# $api::UrlApplySchemeA(pszIn, pszOut, pcchOut, dwFlags)#uselib "SHLWAPI.dll"
#func global UrlApplySchemeA "UrlApplySchemeA" sptr, sptr, sptr, sptr
; UrlApplySchemeA pszIn, varptr(pszOut), varptr(pcchOut), dwFlags ; 戻り値は stat
; pszIn : LPCSTR -> "sptr"
; pszOut : LPSTR out -> "sptr"
; pcchOut : DWORD* in/out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll" #cfunc global UrlApplySchemeA "UrlApplySchemeA" str, var, var, int ; res = UrlApplySchemeA(pszIn, pszOut, pcchOut, dwFlags) ; pszIn : LPCSTR -> "str" ; pszOut : LPSTR out -> "var" ; pcchOut : DWORD* in/out -> "var" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll" #cfunc global UrlApplySchemeA "UrlApplySchemeA" str, sptr, sptr, int ; res = UrlApplySchemeA(pszIn, varptr(pszOut), varptr(pcchOut), dwFlags) ; pszIn : LPCSTR -> "str" ; pszOut : LPSTR out -> "sptr" ; pcchOut : DWORD* in/out -> "sptr" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; HRESULT UrlApplySchemeA(LPCSTR pszIn, LPSTR pszOut, DWORD* pcchOut, DWORD dwFlags) #uselib "SHLWAPI.dll" #cfunc global UrlApplySchemeA "UrlApplySchemeA" str, var, var, int ; res = UrlApplySchemeA(pszIn, pszOut, pcchOut, dwFlags) ; pszIn : LPCSTR -> "str" ; pszOut : LPSTR out -> "var" ; pcchOut : DWORD* in/out -> "var" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT UrlApplySchemeA(LPCSTR pszIn, LPSTR pszOut, DWORD* pcchOut, DWORD dwFlags) #uselib "SHLWAPI.dll" #cfunc global UrlApplySchemeA "UrlApplySchemeA" str, intptr, intptr, int ; res = UrlApplySchemeA(pszIn, varptr(pszOut), varptr(pcchOut), dwFlags) ; pszIn : LPCSTR -> "str" ; pszOut : LPSTR out -> "intptr" ; pcchOut : DWORD* in/out -> "intptr" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procUrlApplySchemeA = shlwapi.NewProc("UrlApplySchemeA")
)
// pszIn (LPCSTR), pszOut (LPSTR out), pcchOut (DWORD* in/out), dwFlags (DWORD)
r1, _, err := procUrlApplySchemeA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszIn))),
uintptr(pszOut),
uintptr(pcchOut),
uintptr(dwFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction UrlApplySchemeA(
pszIn: PAnsiChar; // LPCSTR
pszOut: PAnsiChar; // LPSTR out
pcchOut: Pointer; // DWORD* in/out
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'SHLWAPI.dll' name 'UrlApplySchemeA';result := DllCall("SHLWAPI\UrlApplySchemeA"
, "AStr", pszIn ; LPCSTR
, "Ptr", pszOut ; LPSTR out
, "Ptr", pcchOut ; DWORD* in/out
, "UInt", dwFlags ; DWORD
, "Int") ; return: HRESULT●UrlApplySchemeA(pszIn, pszOut, pcchOut, dwFlags) = DLL("SHLWAPI.dll", "int UrlApplySchemeA(char*, char*, void*, dword)")
# 呼び出し: UrlApplySchemeA(pszIn, pszOut, pcchOut, dwFlags)
# pszIn : LPCSTR -> "char*"
# pszOut : LPSTR out -> "char*"
# pcchOut : DWORD* in/out -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn UrlApplySchemeA(
pszIn: [*c]const u8, // LPCSTR
pszOut: [*c]u8, // LPSTR out
pcchOut: [*c]u32, // DWORD* in/out
dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc UrlApplySchemeA(
pszIn: cstring, # LPCSTR
pszOut: ptr char, # LPSTR out
pcchOut: ptr uint32, # DWORD* in/out
dwFlags: uint32 # DWORD
): int32 {.importc: "UrlApplySchemeA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
int UrlApplySchemeA(
const(char)* pszIn, // LPCSTR
char* pszOut, // LPSTR out
uint* pcchOut, // DWORD* in/out
uint dwFlags // DWORD
);ccall((:UrlApplySchemeA, "SHLWAPI.dll"), stdcall, Int32,
(Cstring, Ptr{UInt8}, Ptr{UInt32}, UInt32),
pszIn, pszOut, pcchOut, dwFlags)
# pszIn : LPCSTR -> Cstring
# pszOut : LPSTR out -> Ptr{UInt8}
# pcchOut : DWORD* in/out -> Ptr{UInt32}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t UrlApplySchemeA(
const char* pszIn,
char* pszOut,
uint32_t* pcchOut,
uint32_t dwFlags);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.UrlApplySchemeA(pszIn, pszOut, pcchOut, dwFlags)
-- pszIn : LPCSTR
-- pszOut : LPSTR out
-- pcchOut : DWORD* in/out
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const UrlApplySchemeA = lib.func('__stdcall', 'UrlApplySchemeA', 'int32_t', ['str', 'char *', 'uint32_t *', 'uint32_t']);
// UrlApplySchemeA(pszIn, pszOut, pcchOut, dwFlags)
// pszIn : LPCSTR -> 'str'
// pszOut : LPSTR out -> 'char *'
// pcchOut : DWORD* in/out -> 'uint32_t *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
UrlApplySchemeA: { parameters: ["buffer", "buffer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.UrlApplySchemeA(pszIn, pszOut, pcchOut, dwFlags)
// pszIn : LPCSTR -> "buffer"
// pszOut : LPSTR out -> "buffer"
// pcchOut : DWORD* in/out -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t UrlApplySchemeA(
const char* pszIn,
char* pszOut,
uint32_t* pcchOut,
uint32_t dwFlags);
C, "SHLWAPI.dll");
// $ffi->UrlApplySchemeA(pszIn, pszOut, pcchOut, dwFlags);
// pszIn : LPCSTR
// pszOut : LPSTR 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.ASCII_OPTIONS);
int UrlApplySchemeA(
String pszIn, // LPCSTR
byte[] pszOut, // LPSTR out
IntByReference pcchOut, // DWORD* in/out
int dwFlags // DWORD
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun UrlApplySchemeA = UrlApplySchemeA(
pszIn : UInt8*, # LPCSTR
pszOut : UInt8*, # LPSTR 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 UrlApplySchemeANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>, Uint32);
typedef UrlApplySchemeADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>, int);
final UrlApplySchemeA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<UrlApplySchemeANative, UrlApplySchemeADart>('UrlApplySchemeA');
// pszIn : LPCSTR -> Pointer<Utf8>
// pszOut : LPSTR out -> Pointer<Utf8>
// pcchOut : DWORD* in/out -> Pointer<Uint32>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function UrlApplySchemeA(
pszIn: PAnsiChar; // LPCSTR
pszOut: PAnsiChar; // LPSTR out
pcchOut: Pointer; // DWORD* in/out
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'SHLWAPI.dll' name 'UrlApplySchemeA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "UrlApplySchemeA"
c_UrlApplySchemeA :: CString -> CString -> Ptr Word32 -> Word32 -> IO Int32
-- pszIn : LPCSTR -> CString
-- pszOut : LPSTR out -> CString
-- pcchOut : DWORD* in/out -> Ptr Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let urlapplyschemea =
foreign "UrlApplySchemeA"
(string @-> string @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* pszIn : LPCSTR -> string *)
(* pszOut : LPSTR out -> string *)
(* 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 ("UrlApplySchemeA" url-apply-scheme-a :convention :stdcall) :int32
(psz-in :string) ; LPCSTR
(psz-out :pointer) ; LPSTR 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 $UrlApplySchemeA = Win32::API::More->new('SHLWAPI',
'int UrlApplySchemeA(LPCSTR pszIn, LPSTR pszOut, LPVOID pcchOut, DWORD dwFlags)');
# my $ret = $UrlApplySchemeA->Call($pszIn, $pszOut, $pcchOut, $dwFlags);
# pszIn : LPCSTR -> LPCSTR
# pszOut : LPSTR out -> LPSTR
# pcchOut : DWORD* in/out -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f UrlApplySchemeW (Unicode版) — スキームのないURLに適切なスキームを補って付与する。