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

SetSoftwareUpdateAdvertisementState

関数
指定した配布ユニットのソフトウェア更新通知状態を設定する。
DLLurlmon.dll呼出規約winapi

シグネチャ

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

HRESULT SetSoftwareUpdateAdvertisementState(
    LPCWSTR szDistUnit,
    DWORD dwAdState,
    DWORD dwAdvertisedVersionMS,
    DWORD dwAdvertisedVersionLS
);

パラメーター

名前方向説明
szDistUnitLPCWSTRin状態を設定する配布単位(コード)を識別するワイド文字列ポインタ。
dwAdStateDWORDin設定するアドバタイズ状態を示すフラグ。SOFTDIST_FLAG_*等を指定する。
dwAdvertisedVersionMSDWORDinアドバタイズするバージョン番号の上位32ビット。
dwAdvertisedVersionLSDWORDinアドバタイズするバージョン番号の下位32ビット。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT SetSoftwareUpdateAdvertisementState(
    LPCWSTR szDistUnit,
    DWORD dwAdState,
    DWORD dwAdvertisedVersionMS,
    DWORD dwAdvertisedVersionLS
);
[DllImport("urlmon.dll", ExactSpelling = true)]
static extern int SetSoftwareUpdateAdvertisementState(
    [MarshalAs(UnmanagedType.LPWStr)] string szDistUnit,   // LPCWSTR
    uint dwAdState,   // DWORD
    uint dwAdvertisedVersionMS,   // DWORD
    uint dwAdvertisedVersionLS   // DWORD
);
<DllImport("urlmon.dll", ExactSpelling:=True)>
Public Shared Function SetSoftwareUpdateAdvertisementState(
    <MarshalAs(UnmanagedType.LPWStr)> szDistUnit As String,   ' LPCWSTR
    dwAdState As UInteger,   ' DWORD
    dwAdvertisedVersionMS As UInteger,   ' DWORD
    dwAdvertisedVersionLS As UInteger   ' DWORD
) As Integer
End Function
' szDistUnit : LPCWSTR
' dwAdState : DWORD
' dwAdvertisedVersionMS : DWORD
' dwAdvertisedVersionLS : DWORD
Declare PtrSafe Function SetSoftwareUpdateAdvertisementState Lib "urlmon" ( _
    ByVal szDistUnit As LongPtr, _
    ByVal dwAdState As Long, _
    ByVal dwAdvertisedVersionMS As Long, _
    ByVal dwAdvertisedVersionLS As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetSoftwareUpdateAdvertisementState = ctypes.windll.urlmon.SetSoftwareUpdateAdvertisementState
SetSoftwareUpdateAdvertisementState.restype = ctypes.c_int
SetSoftwareUpdateAdvertisementState.argtypes = [
    wintypes.LPCWSTR,  # szDistUnit : LPCWSTR
    wintypes.DWORD,  # dwAdState : DWORD
    wintypes.DWORD,  # dwAdvertisedVersionMS : DWORD
    wintypes.DWORD,  # dwAdvertisedVersionLS : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('urlmon.dll')
SetSoftwareUpdateAdvertisementState = Fiddle::Function.new(
  lib['SetSoftwareUpdateAdvertisementState'],
  [
    Fiddle::TYPE_VOIDP,  # szDistUnit : LPCWSTR
    -Fiddle::TYPE_INT,  # dwAdState : DWORD
    -Fiddle::TYPE_INT,  # dwAdvertisedVersionMS : DWORD
    -Fiddle::TYPE_INT,  # dwAdvertisedVersionLS : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "urlmon")]
extern "system" {
    fn SetSoftwareUpdateAdvertisementState(
        szDistUnit: *const u16,  // LPCWSTR
        dwAdState: u32,  // DWORD
        dwAdvertisedVersionMS: u32,  // DWORD
        dwAdvertisedVersionLS: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("urlmon.dll")]
public static extern int SetSoftwareUpdateAdvertisementState([MarshalAs(UnmanagedType.LPWStr)] string szDistUnit, uint dwAdState, uint dwAdvertisedVersionMS, uint dwAdvertisedVersionLS);
"@
$api = Add-Type -MemberDefinition $sig -Name 'urlmon_SetSoftwareUpdateAdvertisementState' -Namespace Win32 -PassThru
# $api::SetSoftwareUpdateAdvertisementState(szDistUnit, dwAdState, dwAdvertisedVersionMS, dwAdvertisedVersionLS)
#uselib "urlmon.dll"
#func global SetSoftwareUpdateAdvertisementState "SetSoftwareUpdateAdvertisementState" sptr, sptr, sptr, sptr
; SetSoftwareUpdateAdvertisementState szDistUnit, dwAdState, dwAdvertisedVersionMS, dwAdvertisedVersionLS   ; 戻り値は stat
; szDistUnit : LPCWSTR -> "sptr"
; dwAdState : DWORD -> "sptr"
; dwAdvertisedVersionMS : DWORD -> "sptr"
; dwAdvertisedVersionLS : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "urlmon.dll"
#cfunc global SetSoftwareUpdateAdvertisementState "SetSoftwareUpdateAdvertisementState" wstr, int, int, int
; res = SetSoftwareUpdateAdvertisementState(szDistUnit, dwAdState, dwAdvertisedVersionMS, dwAdvertisedVersionLS)
; szDistUnit : LPCWSTR -> "wstr"
; dwAdState : DWORD -> "int"
; dwAdvertisedVersionMS : DWORD -> "int"
; dwAdvertisedVersionLS : DWORD -> "int"
; HRESULT SetSoftwareUpdateAdvertisementState(LPCWSTR szDistUnit, DWORD dwAdState, DWORD dwAdvertisedVersionMS, DWORD dwAdvertisedVersionLS)
#uselib "urlmon.dll"
#cfunc global SetSoftwareUpdateAdvertisementState "SetSoftwareUpdateAdvertisementState" wstr, int, int, int
; res = SetSoftwareUpdateAdvertisementState(szDistUnit, dwAdState, dwAdvertisedVersionMS, dwAdvertisedVersionLS)
; szDistUnit : LPCWSTR -> "wstr"
; dwAdState : DWORD -> "int"
; dwAdvertisedVersionMS : DWORD -> "int"
; dwAdvertisedVersionLS : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	urlmon = windows.NewLazySystemDLL("urlmon.dll")
	procSetSoftwareUpdateAdvertisementState = urlmon.NewProc("SetSoftwareUpdateAdvertisementState")
)

// szDistUnit (LPCWSTR), dwAdState (DWORD), dwAdvertisedVersionMS (DWORD), dwAdvertisedVersionLS (DWORD)
r1, _, err := procSetSoftwareUpdateAdvertisementState.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szDistUnit))),
	uintptr(dwAdState),
	uintptr(dwAdvertisedVersionMS),
	uintptr(dwAdvertisedVersionLS),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SetSoftwareUpdateAdvertisementState(
  szDistUnit: PWideChar;   // LPCWSTR
  dwAdState: DWORD;   // DWORD
  dwAdvertisedVersionMS: DWORD;   // DWORD
  dwAdvertisedVersionLS: DWORD   // DWORD
): Integer; stdcall;
  external 'urlmon.dll' name 'SetSoftwareUpdateAdvertisementState';
result := DllCall("urlmon\SetSoftwareUpdateAdvertisementState"
    , "WStr", szDistUnit   ; LPCWSTR
    , "UInt", dwAdState   ; DWORD
    , "UInt", dwAdvertisedVersionMS   ; DWORD
    , "UInt", dwAdvertisedVersionLS   ; DWORD
    , "Int")   ; return: HRESULT
●SetSoftwareUpdateAdvertisementState(szDistUnit, dwAdState, dwAdvertisedVersionMS, dwAdvertisedVersionLS) = DLL("urlmon.dll", "int SetSoftwareUpdateAdvertisementState(char*, dword, dword, dword)")
# 呼び出し: SetSoftwareUpdateAdvertisementState(szDistUnit, dwAdState, dwAdvertisedVersionMS, dwAdvertisedVersionLS)
# szDistUnit : LPCWSTR -> "char*"
# dwAdState : DWORD -> "dword"
# dwAdvertisedVersionMS : DWORD -> "dword"
# dwAdvertisedVersionLS : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "urlmon" fn SetSoftwareUpdateAdvertisementState(
    szDistUnit: [*c]const u16, // LPCWSTR
    dwAdState: u32, // DWORD
    dwAdvertisedVersionMS: u32, // DWORD
    dwAdvertisedVersionLS: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SetSoftwareUpdateAdvertisementState(
    szDistUnit: WideCString,  # LPCWSTR
    dwAdState: uint32,  # DWORD
    dwAdvertisedVersionMS: uint32,  # DWORD
    dwAdvertisedVersionLS: uint32  # DWORD
): int32 {.importc: "SetSoftwareUpdateAdvertisementState", stdcall, dynlib: "urlmon.dll".}
pragma(lib, "urlmon");
extern(Windows)
int SetSoftwareUpdateAdvertisementState(
    const(wchar)* szDistUnit,   // LPCWSTR
    uint dwAdState,   // DWORD
    uint dwAdvertisedVersionMS,   // DWORD
    uint dwAdvertisedVersionLS   // DWORD
);
ccall((:SetSoftwareUpdateAdvertisementState, "urlmon.dll"), stdcall, Int32,
      (Cwstring, UInt32, UInt32, UInt32),
      szDistUnit, dwAdState, dwAdvertisedVersionMS, dwAdvertisedVersionLS)
# szDistUnit : LPCWSTR -> Cwstring
# dwAdState : DWORD -> UInt32
# dwAdvertisedVersionMS : DWORD -> UInt32
# dwAdvertisedVersionLS : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetSoftwareUpdateAdvertisementState(
    const uint16_t* szDistUnit,
    uint32_t dwAdState,
    uint32_t dwAdvertisedVersionMS,
    uint32_t dwAdvertisedVersionLS);
]]
local urlmon = ffi.load("urlmon")
-- urlmon.SetSoftwareUpdateAdvertisementState(szDistUnit, dwAdState, dwAdvertisedVersionMS, dwAdvertisedVersionLS)
-- szDistUnit : LPCWSTR
-- dwAdState : DWORD
-- dwAdvertisedVersionMS : DWORD
-- dwAdvertisedVersionLS : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('urlmon.dll');
const SetSoftwareUpdateAdvertisementState = lib.func('__stdcall', 'SetSoftwareUpdateAdvertisementState', 'int32_t', ['str16', 'uint32_t', 'uint32_t', 'uint32_t']);
// SetSoftwareUpdateAdvertisementState(szDistUnit, dwAdState, dwAdvertisedVersionMS, dwAdvertisedVersionLS)
// szDistUnit : LPCWSTR -> 'str16'
// dwAdState : DWORD -> 'uint32_t'
// dwAdvertisedVersionMS : DWORD -> 'uint32_t'
// dwAdvertisedVersionLS : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("urlmon.dll", {
  SetSoftwareUpdateAdvertisementState: { parameters: ["buffer", "u32", "u32", "u32"], result: "i32" },
});
// lib.symbols.SetSoftwareUpdateAdvertisementState(szDistUnit, dwAdState, dwAdvertisedVersionMS, dwAdvertisedVersionLS)
// szDistUnit : LPCWSTR -> "buffer"
// dwAdState : DWORD -> "u32"
// dwAdvertisedVersionMS : DWORD -> "u32"
// dwAdvertisedVersionLS : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetSoftwareUpdateAdvertisementState(
    const uint16_t* szDistUnit,
    uint32_t dwAdState,
    uint32_t dwAdvertisedVersionMS,
    uint32_t dwAdvertisedVersionLS);
C, "urlmon.dll");
// $ffi->SetSoftwareUpdateAdvertisementState(szDistUnit, dwAdState, dwAdvertisedVersionMS, dwAdvertisedVersionLS);
// szDistUnit : LPCWSTR
// dwAdState : DWORD
// dwAdvertisedVersionMS : DWORD
// dwAdvertisedVersionLS : 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 Urlmon extends StdCallLibrary {
    Urlmon INSTANCE = Native.load("urlmon", Urlmon.class);
    int SetSoftwareUpdateAdvertisementState(
        WString szDistUnit,   // LPCWSTR
        int dwAdState,   // DWORD
        int dwAdvertisedVersionMS,   // DWORD
        int dwAdvertisedVersionLS   // DWORD
    );
}
@[Link("urlmon")]
lib Liburlmon
  fun SetSoftwareUpdateAdvertisementState = SetSoftwareUpdateAdvertisementState(
    szDistUnit : UInt16*,   # LPCWSTR
    dwAdState : UInt32,   # DWORD
    dwAdvertisedVersionMS : UInt32,   # DWORD
    dwAdvertisedVersionLS : 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 SetSoftwareUpdateAdvertisementStateNative = Int32 Function(Pointer<Utf16>, Uint32, Uint32, Uint32);
typedef SetSoftwareUpdateAdvertisementStateDart = int Function(Pointer<Utf16>, int, int, int);
final SetSoftwareUpdateAdvertisementState = DynamicLibrary.open('urlmon.dll')
    .lookupFunction<SetSoftwareUpdateAdvertisementStateNative, SetSoftwareUpdateAdvertisementStateDart>('SetSoftwareUpdateAdvertisementState');
// szDistUnit : LPCWSTR -> Pointer<Utf16>
// dwAdState : DWORD -> Uint32
// dwAdvertisedVersionMS : DWORD -> Uint32
// dwAdvertisedVersionLS : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetSoftwareUpdateAdvertisementState(
  szDistUnit: PWideChar;   // LPCWSTR
  dwAdState: DWORD;   // DWORD
  dwAdvertisedVersionMS: DWORD;   // DWORD
  dwAdvertisedVersionLS: DWORD   // DWORD
): Integer; stdcall;
  external 'urlmon.dll' name 'SetSoftwareUpdateAdvertisementState';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetSoftwareUpdateAdvertisementState"
  c_SetSoftwareUpdateAdvertisementState :: CWString -> Word32 -> Word32 -> Word32 -> IO Int32
-- szDistUnit : LPCWSTR -> CWString
-- dwAdState : DWORD -> Word32
-- dwAdvertisedVersionMS : DWORD -> Word32
-- dwAdvertisedVersionLS : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setsoftwareupdateadvertisementstate =
  foreign "SetSoftwareUpdateAdvertisementState"
    ((ptr uint16_t) @-> uint32_t @-> uint32_t @-> uint32_t @-> returning int32_t)
(* szDistUnit : LPCWSTR -> (ptr uint16_t) *)
(* dwAdState : DWORD -> uint32_t *)
(* dwAdvertisedVersionMS : DWORD -> uint32_t *)
(* dwAdvertisedVersionLS : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library urlmon (t "urlmon.dll"))
(cffi:use-foreign-library urlmon)

(cffi:defcfun ("SetSoftwareUpdateAdvertisementState" set-software-update-advertisement-state :convention :stdcall) :int32
  (sz-dist-unit (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-ad-state :uint32)   ; DWORD
  (dw-advertised-version-ms :uint32)   ; DWORD
  (dw-advertised-version-ls :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetSoftwareUpdateAdvertisementState = Win32::API::More->new('urlmon',
    'int SetSoftwareUpdateAdvertisementState(LPCWSTR szDistUnit, DWORD dwAdState, DWORD dwAdvertisedVersionMS, DWORD dwAdvertisedVersionLS)');
# my $ret = $SetSoftwareUpdateAdvertisementState->Call($szDistUnit, $dwAdState, $dwAdvertisedVersionMS, $dwAdvertisedVersionLS);
# szDistUnit : LPCWSTR -> LPCWSTR
# dwAdState : DWORD -> DWORD
# dwAdvertisedVersionMS : DWORD -> DWORD
# dwAdvertisedVersionLS : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。