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

SHAllocShared

関数
プロセス間で共有可能なメモリブロックを確保する。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HANDLE SHAllocShared(
    const void* pvData,   // optional
    DWORD dwSize,
    DWORD dwProcessId
);

パラメーター

名前方向説明
pvDatavoid*inoptionalコピー対象となる、呼び出し元プロセス内のメモリブロックへのポインターです。データをコピーせずにメモリブロックを共有したい場合は、このパラメーターに NULL を設定できます。
dwSizeDWORDinpvData が指すメモリブロックのサイズ(バイト単位)です。
dwProcessIdDWORDinpvData で指定されたメモリブロックを共有するプロセスのプロセス ID です。

戻り値の型: HANDLE

公式ドキュメント

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

戻り値

型: HANDLE

dwDestinationProcessId で指定されたプロセス用の共有メモリへのハンドルを返します。失敗した場合は NULL を返します。

解説(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>

HANDLE SHAllocShared(
    const void* pvData,   // optional
    DWORD dwSize,
    DWORD dwProcessId
);
[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern IntPtr SHAllocShared(
    IntPtr pvData,   // void* optional
    uint dwSize,   // DWORD
    uint dwProcessId   // DWORD
);
<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function SHAllocShared(
    pvData As IntPtr,   ' void* optional
    dwSize As UInteger,   ' DWORD
    dwProcessId As UInteger   ' DWORD
) As IntPtr
End Function
' pvData : void* optional
' dwSize : DWORD
' dwProcessId : DWORD
Declare PtrSafe Function SHAllocShared Lib "shlwapi" ( _
    ByVal pvData As LongPtr, _
    ByVal dwSize As Long, _
    ByVal dwProcessId As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHAllocShared = ctypes.windll.shlwapi.SHAllocShared
SHAllocShared.restype = ctypes.c_void_p
SHAllocShared.argtypes = [
    ctypes.POINTER(None),  # pvData : void* optional
    wintypes.DWORD,  # dwSize : DWORD
    wintypes.DWORD,  # dwProcessId : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHAllocShared = Fiddle::Function.new(
  lib['SHAllocShared'],
  [
    Fiddle::TYPE_VOIDP,  # pvData : void* optional
    -Fiddle::TYPE_INT,  # dwSize : DWORD
    -Fiddle::TYPE_INT,  # dwProcessId : DWORD
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "shlwapi")]
extern "system" {
    fn SHAllocShared(
        pvData: *const (),  // void* optional
        dwSize: u32,  // DWORD
        dwProcessId: u32  // DWORD
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern IntPtr SHAllocShared(IntPtr pvData, uint dwSize, uint dwProcessId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHAllocShared' -Namespace Win32 -PassThru
# $api::SHAllocShared(pvData, dwSize, dwProcessId)
#uselib "SHLWAPI.dll"
#func global SHAllocShared "SHAllocShared" sptr, sptr, sptr
; SHAllocShared pvData, dwSize, dwProcessId   ; 戻り値は stat
; pvData : void* optional -> "sptr"
; dwSize : DWORD -> "sptr"
; dwProcessId : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global SHAllocShared "SHAllocShared" sptr, int, int
; res = SHAllocShared(pvData, dwSize, dwProcessId)
; pvData : void* optional -> "sptr"
; dwSize : DWORD -> "int"
; dwProcessId : DWORD -> "int"
; HANDLE SHAllocShared(void* pvData, DWORD dwSize, DWORD dwProcessId)
#uselib "SHLWAPI.dll"
#cfunc global SHAllocShared "SHAllocShared" intptr, int, int
; res = SHAllocShared(pvData, dwSize, dwProcessId)
; pvData : void* optional -> "intptr"
; dwSize : DWORD -> "int"
; dwProcessId : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHAllocShared = shlwapi.NewProc("SHAllocShared")
)

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

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

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

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

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

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

関連項目

公式の関連項目