UrlIsW
関数シグネチャ
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
BOOL UrlIsW(
LPCWSTR pszUrl,
URLIS UrlIs
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszUrl | LPCWSTR | in | URL を格納した、最大長 INTERNET_MAX_URL_LENGTH の null 終端文字列です。 |
| UrlIs | URLIS | in | テスト対象とする URL の種類です。このパラメーターには次のいずれかの値を指定できます。 URLIS_APPLIABLEURL の有効なスキームの判別を試みます。 URLIS_DIRECTORYURL 文字列がディレクトリで終わっているかどうか。 URLIS_FILEURLURL がファイル URL かどうか。 URLIS_HASQUERYURL に付加されたクエリ文字列があるかどうか。 URLIS_NOHISTORYURL が通常はナビゲーション履歴に記録されない種類の URL かどうか。 URLIS_OPAQUEURL が不透明 (opaque) かどうか。 URLIS_URLURL が有効かどうか。 - UrlIs.URLIS_APPLIABLEURL の有効なスキームの判別を試みます。 - UrlIs.URLIS_DIRECTORYURL 文字列がディレクトリで終わっているかどうか。 - UrlIs.URLIS_FILEURLURL がファイル URL かどうか。 - UrlIs.URLIS_HASQUERYURL に付加されたクエリ文字列があるかどうか。 - UrlIs.URLIS_NOHISTORYURL が通常はナビゲーション履歴に記録されない種類の URL かどうか。 - UrlIs.URLIS_OPAQUEURL が不透明 (opaque) かどうか。 - UrlIs.URLIS_URLURL が有効かどうか。 |
戻り値の型: BOOL
公式ドキュメント
URL が指定された種類かどうかをテストします。(Unicode)
戻り値
型: BOOL
1 つを除くすべての URL の種類について、UrlIs は URL が指定された種類であれば TRUE を、そうでなければ FALSE を返します。
UrlIs に URLIS_APPLIABLE が設定されている場合、UrlIs は URL のスキームの判別を試みます。スキームを判別できた場合は TRUE を、それ以外の場合は FALSE を返します。
解説(Remarks)
shlwapi.h ヘッダーは UrlIs を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードとを混在させると、不整合が生じてコンパイルエラーまたは実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規約を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
BOOL UrlIsW(
LPCWSTR pszUrl,
URLIS UrlIs
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool UrlIsW(
[MarshalAs(UnmanagedType.LPWStr)] string pszUrl, // LPCWSTR
int UrlIs // URLIS
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function UrlIsW(
<MarshalAs(UnmanagedType.LPWStr)> pszUrl As String, ' LPCWSTR
UrlIs As Integer ' URLIS
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' pszUrl : LPCWSTR
' UrlIs : URLIS
Declare PtrSafe Function UrlIsW Lib "shlwapi" ( _
ByVal pszUrl As LongPtr, _
ByVal UrlIs 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
UrlIsW = ctypes.windll.shlwapi.UrlIsW
UrlIsW.restype = wintypes.BOOL
UrlIsW.argtypes = [
wintypes.LPCWSTR, # pszUrl : LPCWSTR
ctypes.c_int, # UrlIs : URLIS
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
UrlIsW = Fiddle::Function.new(
lib['UrlIsW'],
[
Fiddle::TYPE_VOIDP, # pszUrl : LPCWSTR
Fiddle::TYPE_INT, # UrlIs : URLIS
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "shlwapi")]
extern "system" {
fn UrlIsW(
pszUrl: *const u16, // LPCWSTR
UrlIs: i32 // URLIS
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern bool UrlIsW([MarshalAs(UnmanagedType.LPWStr)] string pszUrl, int UrlIs);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_UrlIsW' -Namespace Win32 -PassThru
# $api::UrlIsW(pszUrl, UrlIs)#uselib "SHLWAPI.dll"
#func global UrlIsW "UrlIsW" wptr, wptr
; UrlIsW pszUrl, UrlIs ; 戻り値は stat
; pszUrl : LPCWSTR -> "wptr"
; UrlIs : URLIS -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll"
#cfunc global UrlIsW "UrlIsW" wstr, int
; res = UrlIsW(pszUrl, UrlIs)
; pszUrl : LPCWSTR -> "wstr"
; UrlIs : URLIS -> "int"; BOOL UrlIsW(LPCWSTR pszUrl, URLIS UrlIs)
#uselib "SHLWAPI.dll"
#cfunc global UrlIsW "UrlIsW" wstr, int
; res = UrlIsW(pszUrl, UrlIs)
; pszUrl : LPCWSTR -> "wstr"
; UrlIs : URLIS -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procUrlIsW = shlwapi.NewProc("UrlIsW")
)
// pszUrl (LPCWSTR), UrlIs (URLIS)
r1, _, err := procUrlIsW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszUrl))),
uintptr(UrlIs),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction UrlIsW(
pszUrl: PWideChar; // LPCWSTR
UrlIs: Integer // URLIS
): BOOL; stdcall;
external 'SHLWAPI.dll' name 'UrlIsW';result := DllCall("SHLWAPI\UrlIsW"
, "WStr", pszUrl ; LPCWSTR
, "Int", UrlIs ; URLIS
, "Int") ; return: BOOL●UrlIsW(pszUrl, UrlIs) = DLL("SHLWAPI.dll", "bool UrlIsW(char*, int)")
# 呼び出し: UrlIsW(pszUrl, UrlIs)
# pszUrl : LPCWSTR -> "char*"
# UrlIs : URLIS -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "shlwapi" fn UrlIsW(
pszUrl: [*c]const u16, // LPCWSTR
UrlIs: i32 // URLIS
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc UrlIsW(
pszUrl: WideCString, # LPCWSTR
UrlIs: int32 # URLIS
): int32 {.importc: "UrlIsW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shlwapi");
extern(Windows)
int UrlIsW(
const(wchar)* pszUrl, // LPCWSTR
int UrlIs // URLIS
);ccall((:UrlIsW, "SHLWAPI.dll"), stdcall, Int32,
(Cwstring, Int32),
pszUrl, UrlIs)
# pszUrl : LPCWSTR -> Cwstring
# UrlIs : URLIS -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t UrlIsW(
const uint16_t* pszUrl,
int32_t UrlIs);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.UrlIsW(pszUrl, UrlIs)
-- pszUrl : LPCWSTR
-- UrlIs : URLIS
-- 構造体/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 UrlIsW = lib.func('__stdcall', 'UrlIsW', 'int32_t', ['str16', 'int32_t']);
// UrlIsW(pszUrl, UrlIs)
// pszUrl : LPCWSTR -> 'str16'
// UrlIs : URLIS -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
UrlIsW: { parameters: ["buffer", "i32"], result: "i32" },
});
// lib.symbols.UrlIsW(pszUrl, UrlIs)
// pszUrl : LPCWSTR -> "buffer"
// UrlIs : URLIS -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t UrlIsW(
const uint16_t* pszUrl,
int32_t UrlIs);
C, "SHLWAPI.dll");
// $ffi->UrlIsW(pszUrl, UrlIs);
// pszUrl : LPCWSTR
// UrlIs : URLIS
// 構造体/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);
boolean UrlIsW(
WString pszUrl, // LPCWSTR
int UrlIs // URLIS
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shlwapi")]
lib LibSHLWAPI
fun UrlIsW = UrlIsW(
pszUrl : UInt16*, # LPCWSTR
UrlIs : Int32 # URLIS
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef UrlIsWNative = Int32 Function(Pointer<Utf16>, Int32);
typedef UrlIsWDart = int Function(Pointer<Utf16>, int);
final UrlIsW = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<UrlIsWNative, UrlIsWDart>('UrlIsW');
// pszUrl : LPCWSTR -> Pointer<Utf16>
// UrlIs : URLIS -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function UrlIsW(
pszUrl: PWideChar; // LPCWSTR
UrlIs: Integer // URLIS
): BOOL; stdcall;
external 'SHLWAPI.dll' name 'UrlIsW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "UrlIsW"
c_UrlIsW :: CWString -> Int32 -> IO CInt
-- pszUrl : LPCWSTR -> CWString
-- UrlIs : URLIS -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let urlisw =
foreign "UrlIsW"
((ptr uint16_t) @-> int32_t @-> returning int32_t)
(* pszUrl : LPCWSTR -> (ptr uint16_t) *)
(* UrlIs : URLIS -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)
(cffi:defcfun ("UrlIsW" url-is-w :convention :stdcall) :int32
(psz-url (:string :encoding :utf-16le)) ; LPCWSTR
(url-is :int32)) ; URLIS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $UrlIsW = Win32::API::More->new('SHLWAPI',
'BOOL UrlIsW(LPCWSTR pszUrl, int UrlIs)');
# my $ret = $UrlIsW->Call($pszUrl, $UrlIs);
# pszUrl : LPCWSTR -> LPCWSTR
# UrlIs : URLIS -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f UrlIsA (ANSI版) — URLが指定した種別の条件を満たすかどうかを判定する。
- f UrlIsNoHistoryW — URLが履歴に残さない種類かどうかを判定する。
- f UrlIsOpaqueW — URLが不透明(opaque)形式かどうかを判定する。