Win32 API 日本語リファレンス
ホームNetworking.WinHttp › WinHttpCheckPlatform

WinHttpCheckPlatform

関数
現在のプラットフォームがWinHTTPに対応するか確認する。
DLLWINHTTP.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// WINHTTP.dll
#include <windows.h>

BOOL WinHttpCheckPlatform(void);

パラメーターなし。戻り値: BOOL

公式ドキュメント

WinHttpCheckPlatform 関数は、現在のプラットフォームがこのバージョンの Microsoft Windows HTTP Services (WinHTTP) でサポートされているかどうかを判定します。

戻り値

プラットフォームが Microsoft Windows HTTP Services (WinHTTP) でサポートされている場合は TRUE、そうでない場合は FALSE が返ります。

解説(Remarks)

この関数は、アプリケーションが Microsoft Windows HTTP Services (WinHTTP) を使用しつつ、WinHTTP がサポートしないプラットフォームにも対応している場合に役立ちます。

WinHTTP を非同期モードで使用する場合(つまり WinHttpOpenWINHTTP_FLAG_ASYNC が設定されている場合)であっても、この関数は同期的に動作します。戻り値は成功または失敗を示します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

WinHTTP バージョン 5.1 は、Service Pack 3 (SP3) 以降の Windows 2000(Datacenter Server を除く)、Service Pack 1 (SP1) 以降の Windows XP、および Windows Server 2003 のオペレーティングシステムコンポーネントです。Windows Server 2003 では、WinHTTP はシステムの side-by-side アセンブリです。

詳細については、Run-Time Requirements を参照してください。

次の例は、現在のプラットフォームがサポートされているかどうかを判定する方法を示しています。

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

各言語での呼び出し定義

// WINHTTP.dll
#include <windows.h>

BOOL WinHttpCheckPlatform(void);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinHttpCheckPlatform();
<DllImport("WINHTTP.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHttpCheckPlatform() As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
Declare PtrSafe Function WinHttpCheckPlatform Lib "winhttp" () As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WinHttpCheckPlatform = ctypes.windll.winhttp.WinHttpCheckPlatform
WinHttpCheckPlatform.restype = wintypes.BOOL
WinHttpCheckPlatform.argtypes = []
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpCheckPlatform = Fiddle::Function.new(
  lib['WinHttpCheckPlatform'],
  [],
  Fiddle::TYPE_INT)
#[link(name = "winhttp")]
extern "system" {
    fn WinHttpCheckPlatform() -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true)]
public static extern bool WinHttpCheckPlatform();
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpCheckPlatform' -Namespace Win32 -PassThru
# $api::WinHttpCheckPlatform()
#uselib "WINHTTP.dll"
#func global WinHttpCheckPlatform "WinHttpCheckPlatform"
; WinHttpCheckPlatform   ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINHTTP.dll"
#cfunc global WinHttpCheckPlatform "WinHttpCheckPlatform"
; res = WinHttpCheckPlatform()
; BOOL WinHttpCheckPlatform()
#uselib "WINHTTP.dll"
#cfunc global WinHttpCheckPlatform "WinHttpCheckPlatform"
; res = WinHttpCheckPlatform()
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
	procWinHttpCheckPlatform = winhttp.NewProc("WinHttpCheckPlatform")
)

r1, _, err := procWinHttpCheckPlatform.Call()
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WinHttpCheckPlatform: BOOL; stdcall;
  external 'WINHTTP.dll' name 'WinHttpCheckPlatform';
result := DllCall("WINHTTP\WinHttpCheckPlatform", "Int")
●WinHttpCheckPlatform() = DLL("WINHTTP.dll", "bool WinHttpCheckPlatform()")
# 呼び出し: WinHttpCheckPlatform()
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winhttp" fn WinHttpCheckPlatform() callconv(std.os.windows.WINAPI) i32;
proc WinHttpCheckPlatform(): int32 {.importc: "WinHttpCheckPlatform", stdcall, dynlib: "WINHTTP.dll".}
pragma(lib, "winhttp");
extern(Windows)
int WinHttpCheckPlatform();
ccall((:WinHttpCheckPlatform, "WINHTTP.dll"), stdcall, Int32,
      (),
      )
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WinHttpCheckPlatform(void);
]]
local winhttp = ffi.load("winhttp")
-- winhttp.WinHttpCheckPlatform()
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINHTTP.dll');
const WinHttpCheckPlatform = lib.func('__stdcall', 'WinHttpCheckPlatform', 'int32_t', []);
// WinHttpCheckPlatform()
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINHTTP.dll", {
  WinHttpCheckPlatform: { parameters: [], result: "i32" },
});
// lib.symbols.WinHttpCheckPlatform()
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WinHttpCheckPlatform(void);
C, "WINHTTP.dll");
// $ffi->WinHttpCheckPlatform();
// 構造体/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 Winhttp extends StdCallLibrary {
    Winhttp INSTANCE = Native.load("winhttp", Winhttp.class);
    boolean WinHttpCheckPlatform();
}
@[Link("winhttp")]
lib LibWINHTTP
  fun WinHttpCheckPlatform = WinHttpCheckPlatform() : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WinHttpCheckPlatformNative = Int32 Function();
typedef WinHttpCheckPlatformDart = int Function();
final WinHttpCheckPlatform = DynamicLibrary.open('WINHTTP.dll')
    .lookupFunction<WinHttpCheckPlatformNative, WinHttpCheckPlatformDart>('WinHttpCheckPlatform');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinHttpCheckPlatform: BOOL; stdcall;
  external 'WINHTTP.dll' name 'WinHttpCheckPlatform';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinHttpCheckPlatform"
  c_WinHttpCheckPlatform :: IO CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winhttpcheckplatform =
  foreign "WinHttpCheckPlatform"
    (void @-> returning int32_t)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winhttp (t "WINHTTP.dll"))
(cffi:use-foreign-library winhttp)

(cffi:defcfun ("WinHttpCheckPlatform" win-http-check-platform :convention :stdcall) :int32)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinHttpCheckPlatform = Win32::API::More->new('WINHTTP',
    'BOOL WinHttpCheckPlatform()');
# my $ret = $WinHttpCheckPlatform->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。