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

SHUnlockShared

関数
共有メモリブロックのマッピングを解除する。
DLLSHLWAPI.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SHUnlockShared(
    void* pvData
);

パラメーター

名前方向説明
pvDatavoid*inSHLockShared によって返された共有メモリ ブロックへのポインター。

戻り値の型: BOOL

公式ドキュメント

SHUnlockShared は変更されるか、利用できなくなる可能性があります。

戻り値

型: BOOL

関数が成功した場合、戻り値は TRUE であり、指定された範囲内のすべての変更されたページが低優先度でディスクに書き込まれます。関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

メモリ ブロックを解放するには、SHFreeShared を呼び出します。

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

各言語での呼び出し定義

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

BOOL SHUnlockShared(
    void* pvData
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SHUnlockShared(
    IntPtr pvData   // void*
);
<DllImport("SHLWAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SHUnlockShared(
    pvData As IntPtr   ' void*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pvData : void*
Declare PtrSafe Function SHUnlockShared Lib "shlwapi" ( _
    ByVal pvData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHUnlockShared = ctypes.windll.shlwapi.SHUnlockShared
SHUnlockShared.restype = wintypes.BOOL
SHUnlockShared.argtypes = [
    ctypes.POINTER(None),  # pvData : void*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHUnlockShared = Fiddle::Function.new(
  lib['SHUnlockShared'],
  [
    Fiddle::TYPE_VOIDP,  # pvData : void*
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn SHUnlockShared(
        pvData: *mut ()  // void*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", SetLastError = true)]
public static extern bool SHUnlockShared(IntPtr pvData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHUnlockShared' -Namespace Win32 -PassThru
# $api::SHUnlockShared(pvData)
#uselib "SHLWAPI.dll"
#func global SHUnlockShared "SHUnlockShared" sptr
; SHUnlockShared pvData   ; 戻り値は stat
; pvData : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global SHUnlockShared "SHUnlockShared" sptr
; res = SHUnlockShared(pvData)
; pvData : void* -> "sptr"
; BOOL SHUnlockShared(void* pvData)
#uselib "SHLWAPI.dll"
#cfunc global SHUnlockShared "SHUnlockShared" intptr
; res = SHUnlockShared(pvData)
; pvData : void* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHUnlockShared = shlwapi.NewProc("SHUnlockShared")
)

// pvData (void*)
r1, _, err := procSHUnlockShared.Call(
	uintptr(pvData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SHUnlockShared(
  pvData: Pointer   // void*
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'SHUnlockShared';
result := DllCall("SHLWAPI\SHUnlockShared"
    , "Ptr", pvData   ; void*
    , "Int")   ; return: BOOL
●SHUnlockShared(pvData) = DLL("SHLWAPI.dll", "bool SHUnlockShared(void*)")
# 呼び出し: SHUnlockShared(pvData)
# pvData : void* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SHUnlockSharedNative = Int32 Function(Pointer<Void>);
typedef SHUnlockSharedDart = int Function(Pointer<Void>);
final SHUnlockShared = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHUnlockSharedNative, SHUnlockSharedDart>('SHUnlockShared');
// pvData : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHUnlockShared(
  pvData: Pointer   // void*
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'SHUnlockShared';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHUnlockShared"
  c_SHUnlockShared :: Ptr () -> IO CInt
-- pvData : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shunlockshared =
  foreign "SHUnlockShared"
    ((ptr void) @-> returning int32_t)
(* pvData : void* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHUnlockShared" shunlock-shared :convention :stdcall) :int32
  (pv-data :pointer))   ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHUnlockShared = Win32::API::More->new('SHLWAPI',
    'BOOL SHUnlockShared(LPVOID pvData)');
# my $ret = $SHUnlockShared->Call($pvData);
# pvData : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。