Win32 API 日本語リファレンス
ホームUI.Shell › HlinkSetSpecialReference

HlinkSetSpecialReference

関数
ホームや検索ページなど特殊参照を設定する。
DLLhlink.dll呼出規約winapi

シグネチャ

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

HRESULT HlinkSetSpecialReference(
    DWORD uReference,
    LPCWSTR pwzReference
);

パラメーター

名前方向説明
uReferenceDWORDin設定する特殊参照の種別。HLSR_HOME/HLSR_SEARCHPAGE等で対象を指定する。
pwzReferenceLPCWSTRin設定する参照文字列(URL)。NULL指定で既定に戻せる。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

HlinkSetSpecialReference = ctypes.windll.hlink.HlinkSetSpecialReference
HlinkSetSpecialReference.restype = ctypes.c_int
HlinkSetSpecialReference.argtypes = [
    wintypes.DWORD,  # uReference : DWORD
    wintypes.LPCWSTR,  # pwzReference : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	hlink = windows.NewLazySystemDLL("hlink.dll")
	procHlinkSetSpecialReference = hlink.NewProc("HlinkSetSpecialReference")
)

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

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

typedef HlinkSetSpecialReferenceNative = Int32 Function(Uint32, Pointer<Utf16>);
typedef HlinkSetSpecialReferenceDart = int Function(int, Pointer<Utf16>);
final HlinkSetSpecialReference = DynamicLibrary.open('hlink.dll')
    .lookupFunction<HlinkSetSpecialReferenceNative, HlinkSetSpecialReferenceDart>('HlinkSetSpecialReference');
// uReference : DWORD -> Uint32
// pwzReference : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HlinkSetSpecialReference(
  uReference: DWORD;   // DWORD
  pwzReference: PWideChar   // LPCWSTR
): Integer; stdcall;
  external 'hlink.dll' name 'HlinkSetSpecialReference';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let hlinksetspecialreference =
  foreign "HlinkSetSpecialReference"
    (uint32_t @-> (ptr uint16_t) @-> returning int32_t)
(* uReference : DWORD -> uint32_t *)
(* pwzReference : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library hlink (t "hlink.dll"))
(cffi:use-foreign-library hlink)

(cffi:defcfun ("HlinkSetSpecialReference" hlink-set-special-reference :convention :stdcall) :int32
  (u-reference :uint32)   ; DWORD
  (pwz-reference (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HlinkSetSpecialReference = Win32::API::More->new('hlink',
    'int HlinkSetSpecialReference(DWORD uReference, LPCWSTR pwzReference)');
# my $ret = $HlinkSetSpecialReference->Call($uReference, $pwzReference);
# uReference : DWORD -> DWORD
# pwzReference : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。