SHSkipJunction

関数

バインドコンテキストでジャンクションを飛ばすか判定する。

DLLSHLWAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL SHSkipJunction(
    IBindCtx* pbc,   // optional
    const GUID* pclsid
);

パラメーター

名前	型	方向	説明
pbc	IBindCtx*	inoptional	確認するバインドコンテキストを指定する IBindCtx インターフェイスへのポインター。この値は NULL でもかまいません。
pclsid	GUID*	in	スキップする必要があるかどうかをテストするオブジェクトの CLSID を指定する変数へのポインター。通常、これは IShellFolder::BindToObject がこれから作成しようとしているオブジェクトの CLSID です。

戻り値の型: BOOL

公式ドキュメント

バインドコンテキストを調べ、特定のコンポーネントオブジェクトへのバインドが安全かどうかを確認します。

戻り値

型: BOOL

pclsid で指定されたオブジェクトをスキップする必要がある場合は TRUE を、それ以外の場合は FALSE を返します。

解説(Remarks)

この関数は、名前空間バインドにおける無限ループを回避するために使用できます。たとえば、名前空間ツリー内で自身より上位にあるフォルダーを参照するフォルダーショートカットは、無限に再帰するループを生成する可能性があります。

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

各言語での呼び出し定義

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

BOOL SHSkipJunction(
    IBindCtx* pbc,   // optional
    const GUID* pclsid
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern bool SHSkipJunction(
    IntPtr pbc,   // IBindCtx* optional
    ref Guid pclsid   // GUID*
);

<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function SHSkipJunction(
    pbc As IntPtr,   ' IBindCtx* optional
    ByRef pclsid As Guid   ' GUID*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pbc : IBindCtx* optional
' pclsid : GUID*
Declare PtrSafe Function SHSkipJunction Lib "shlwapi" ( _
    ByVal pbc As LongPtr, _
    ByVal pclsid As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHSkipJunction = ctypes.windll.shlwapi.SHSkipJunction
SHSkipJunction.restype = wintypes.BOOL
SHSkipJunction.argtypes = [
    ctypes.c_void_p,  # pbc : IBindCtx* optional
    ctypes.c_void_p,  # pclsid : GUID*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHSkipJunction = Fiddle::Function.new(
  lib['SHSkipJunction'],
  [
    Fiddle::TYPE_VOIDP,  # pbc : IBindCtx* optional
    Fiddle::TYPE_VOIDP,  # pclsid : GUID*
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn SHSkipJunction(
        pbc: *mut core::ffi::c_void,  // IBindCtx* optional
        pclsid: *const GUID  // GUID*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll")]
public static extern bool SHSkipJunction(IntPtr pbc, ref Guid pclsid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHSkipJunction' -Namespace Win32 -PassThru
# $api::SHSkipJunction(pbc, pclsid)

#uselib "SHLWAPI.dll"
#func global SHSkipJunction "SHSkipJunction" sptr, sptr
; SHSkipJunction pbc, varptr(pclsid)   ; 戻り値は stat
; pbc : IBindCtx* optional -> "sptr"
; pclsid : GUID* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global SHSkipJunction "SHSkipJunction" sptr, var
; res = SHSkipJunction(pbc, pclsid)
; pbc : IBindCtx* optional -> "sptr"
; pclsid : GUID* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global SHSkipJunction "SHSkipJunction" sptr, sptr
; res = SHSkipJunction(pbc, varptr(pclsid))
; pbc : IBindCtx* optional -> "sptr"
; pclsid : GUID* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。