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

HlinkGetSpecialReference

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

シグネチャ

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

HRESULT HlinkGetSpecialReference(
    DWORD uReference,
    LPWSTR* ppwzReference
);

パラメーター

名前方向説明
uReferenceDWORDin取得する特殊参照の種別。HLSR_HOME/HLSR_SEARCHPAGE等で対象を指定する。
ppwzReferenceLPWSTR*out取得した参照文字列を受け取る出力先。呼び出し側が解放する。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

HlinkGetSpecialReference = ctypes.windll.hlink.HlinkGetSpecialReference
HlinkGetSpecialReference.restype = ctypes.c_int
HlinkGetSpecialReference.argtypes = [
    wintypes.DWORD,  # uReference : DWORD
    ctypes.c_void_p,  # ppwzReference : LPWSTR* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	hlink = windows.NewLazySystemDLL("hlink.dll")
	procHlinkGetSpecialReference = hlink.NewProc("HlinkGetSpecialReference")
)

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

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

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

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

let hlinkgetspecialreference =
  foreign "HlinkGetSpecialReference"
    (uint32_t @-> (ptr (ptr uint16_t)) @-> returning int32_t)
(* uReference : DWORD -> uint32_t *)
(* ppwzReference : LPWSTR* out -> (ptr (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 ("HlinkGetSpecialReference" hlink-get-special-reference :convention :stdcall) :int32
  (u-reference :uint32)   ; DWORD
  (ppwz-reference :pointer))   ; LPWSTR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HlinkGetSpecialReference = Win32::API::More->new('hlink',
    'int HlinkGetSpecialReference(DWORD uReference, LPVOID ppwzReference)');
# my $ret = $HlinkGetSpecialReference->Call($uReference, $ppwzReference);
# uReference : DWORD -> DWORD
# ppwzReference : LPWSTR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。