Win32 API 日本語リファレンス
ホームSystem.Com.Urlmon › ObtainUserAgentString

ObtainUserAgentString

関数
URLモニカーが使用するユーザーエージェント文字列を取得する。
DLLurlmon.dll呼出規約winapi

シグネチャ

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

HRESULT ObtainUserAgentString(
    DWORD dwOption,
    LPSTR pszUAOut,
    DWORD* cbSize
);

パラメーター

名前方向説明
dwOptionDWORDin取得動作を制御するオプション。0で既定のユーザーエージェントを返す。
pszUAOutLPSTRoutユーザーエージェント文字列(ANSI)を書き込む出力バッファへのポインタ。
cbSizeDWORD*inout入力でバッファサイズ、出力で必要/書込バイト数を受け渡すDWORDへのポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT ObtainUserAgentString(
    DWORD dwOption,
    LPSTR pszUAOut,
    DWORD* cbSize
);
[DllImport("urlmon.dll", ExactSpelling = true)]
static extern int ObtainUserAgentString(
    uint dwOption,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszUAOut,   // LPSTR out
    ref uint cbSize   // DWORD* in/out
);
<DllImport("urlmon.dll", ExactSpelling:=True)>
Public Shared Function ObtainUserAgentString(
    dwOption As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> pszUAOut As System.Text.StringBuilder,   ' LPSTR out
    ByRef cbSize As UInteger   ' DWORD* in/out
) As Integer
End Function
' dwOption : DWORD
' pszUAOut : LPSTR out
' cbSize : DWORD* in/out
Declare PtrSafe Function ObtainUserAgentString Lib "urlmon" ( _
    ByVal dwOption As Long, _
    ByVal pszUAOut As String, _
    ByRef cbSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ObtainUserAgentString = ctypes.windll.urlmon.ObtainUserAgentString
ObtainUserAgentString.restype = ctypes.c_int
ObtainUserAgentString.argtypes = [
    wintypes.DWORD,  # dwOption : DWORD
    wintypes.LPSTR,  # pszUAOut : LPSTR out
    ctypes.POINTER(wintypes.DWORD),  # cbSize : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('urlmon.dll')
ObtainUserAgentString = Fiddle::Function.new(
  lib['ObtainUserAgentString'],
  [
    -Fiddle::TYPE_INT,  # dwOption : DWORD
    Fiddle::TYPE_VOIDP,  # pszUAOut : LPSTR out
    Fiddle::TYPE_VOIDP,  # cbSize : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "urlmon")]
extern "system" {
    fn ObtainUserAgentString(
        dwOption: u32,  // DWORD
        pszUAOut: *mut u8,  // LPSTR out
        cbSize: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("urlmon.dll")]
public static extern int ObtainUserAgentString(uint dwOption, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszUAOut, ref uint cbSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'urlmon_ObtainUserAgentString' -Namespace Win32 -PassThru
# $api::ObtainUserAgentString(dwOption, pszUAOut, cbSize)
#uselib "urlmon.dll"
#func global ObtainUserAgentString "ObtainUserAgentString" sptr, sptr, sptr
; ObtainUserAgentString dwOption, varptr(pszUAOut), varptr(cbSize)   ; 戻り値は stat
; dwOption : DWORD -> "sptr"
; pszUAOut : LPSTR out -> "sptr"
; cbSize : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "urlmon.dll"
#cfunc global ObtainUserAgentString "ObtainUserAgentString" int, var, var
; res = ObtainUserAgentString(dwOption, pszUAOut, cbSize)
; dwOption : DWORD -> "int"
; pszUAOut : LPSTR out -> "var"
; cbSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT ObtainUserAgentString(DWORD dwOption, LPSTR pszUAOut, DWORD* cbSize)
#uselib "urlmon.dll"
#cfunc global ObtainUserAgentString "ObtainUserAgentString" int, var, var
; res = ObtainUserAgentString(dwOption, pszUAOut, cbSize)
; dwOption : DWORD -> "int"
; pszUAOut : LPSTR out -> "var"
; cbSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	urlmon = windows.NewLazySystemDLL("urlmon.dll")
	procObtainUserAgentString = urlmon.NewProc("ObtainUserAgentString")
)

// dwOption (DWORD), pszUAOut (LPSTR out), cbSize (DWORD* in/out)
r1, _, err := procObtainUserAgentString.Call(
	uintptr(dwOption),
	uintptr(pszUAOut),
	uintptr(cbSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function ObtainUserAgentString(
  dwOption: DWORD;   // DWORD
  pszUAOut: PAnsiChar;   // LPSTR out
  cbSize: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'urlmon.dll' name 'ObtainUserAgentString';
result := DllCall("urlmon\ObtainUserAgentString"
    , "UInt", dwOption   ; DWORD
    , "Ptr", pszUAOut   ; LPSTR out
    , "Ptr", cbSize   ; DWORD* in/out
    , "Int")   ; return: HRESULT
●ObtainUserAgentString(dwOption, pszUAOut, cbSize) = DLL("urlmon.dll", "int ObtainUserAgentString(dword, char*, void*)")
# 呼び出し: ObtainUserAgentString(dwOption, pszUAOut, cbSize)
# dwOption : DWORD -> "dword"
# pszUAOut : LPSTR out -> "char*"
# cbSize : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef ObtainUserAgentStringNative = Int32 Function(Uint32, Pointer<Utf8>, Pointer<Uint32>);
typedef ObtainUserAgentStringDart = int Function(int, Pointer<Utf8>, Pointer<Uint32>);
final ObtainUserAgentString = DynamicLibrary.open('urlmon.dll')
    .lookupFunction<ObtainUserAgentStringNative, ObtainUserAgentStringDart>('ObtainUserAgentString');
// dwOption : DWORD -> Uint32
// pszUAOut : LPSTR out -> Pointer<Utf8>
// cbSize : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ObtainUserAgentString(
  dwOption: DWORD;   // DWORD
  pszUAOut: PAnsiChar;   // LPSTR out
  cbSize: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'urlmon.dll' name 'ObtainUserAgentString';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ObtainUserAgentString"
  c_ObtainUserAgentString :: Word32 -> CString -> Ptr Word32 -> IO Int32
-- dwOption : DWORD -> Word32
-- pszUAOut : LPSTR out -> CString
-- cbSize : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let obtainuseragentstring =
  foreign "ObtainUserAgentString"
    (uint32_t @-> string @-> (ptr uint32_t) @-> returning int32_t)
(* dwOption : DWORD -> uint32_t *)
(* pszUAOut : LPSTR out -> string *)
(* cbSize : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library urlmon (t "urlmon.dll"))
(cffi:use-foreign-library urlmon)

(cffi:defcfun ("ObtainUserAgentString" obtain-user-agent-string :convention :stdcall) :int32
  (dw-option :uint32)   ; DWORD
  (psz-uaout :pointer)   ; LPSTR out
  (cb-size :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ObtainUserAgentString = Win32::API::More->new('urlmon',
    'int ObtainUserAgentString(DWORD dwOption, LPSTR pszUAOut, LPVOID cbSize)');
# my $ret = $ObtainUserAgentString->Call($dwOption, $pszUAOut, $cbSize);
# dwOption : DWORD -> DWORD
# pszUAOut : LPSTR out -> LPSTR
# cbSize : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。