ReleaseStgMedium

関数

ストレージメディウム構造体のリソースを解放する。

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

シグネチャ

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

void ReleaseStgMedium(
    STGMEDIUM* param0
);

パラメーター

名前	型	方向	説明
param0	STGMEDIUM*	inout	解放する記憶媒体を保持するSTGMEDIUM構造体へのポインタ。

戻り値の型: void

公式ドキュメント

指定された記憶媒体 (storage medium) を解放します。

解説(Remarks)

ReleaseStgMedium 関数は、指定された記憶媒体を解放するために適切なメソッドまたは関数を呼び出します。この関数は、IDataObject::GetData や IDataObject::SetData のように、記憶媒体の構造体がパラメーターとなるデータ転送操作で使用します。この構造体は、記憶媒体の種類を識別するだけでなく、媒体が不要になったときに解放するための適切な Release メソッドも指定します。

STGMEDIUM を、IDataObject::GetData のように、あるコードから別のコードへ受け渡すことはよくあります。この場合、呼び出された側が媒体を割り当てて呼び出し元に返すことができます。ReleaseStgMedium は、受け取った側のコードが媒体を所有するのか、それとも媒体を提供した元の側がなお所有しており、受け取った側が解放可能であることを提供側に通知する必要があるのか、という点で柔軟性を提供します。

媒体を提供した元の側が媒体の解放に責任を持つ場合、提供側は ReleaseStgMedium を呼び出し、媒体と適切な IUnknown ポインターを punkForRelease 構造体メンバーとして指定します。解放する記憶媒体の種類に応じて次のいずれかのアクションが実行され、その後、指定された IUnknown ポインターに対して IUnknown::Release メソッドが呼び出されます。

媒体	ReleaseStgMedium のアクション
TYMED_HGLOBAL	なし。
TYMED_GDI	なし。
TYMED_ENHMF	なし。
TYMED_MFPICT	なし。
TYMED_FILE	標準のメモリ管理機構を使用してファイル名文字列を解放します。
TYMED_ISTREAM	IStream::Release を呼び出します。
TYMED_ISTORAGE	IStorage::Release を呼び出します。

提供側は、punkForRelease 構造体メンバーに NULL を指定することで、媒体の受け取り側が媒体の解放に責任を持つことを示します。この場合、受け取り側が ReleaseStgMedium を呼び出すと、解放する記憶媒体の種類に応じて、次の表に示すとおりの呼び出しが行われます。

媒体	ReleaseStgMedium のアクション
TYMED_HGLOBAL	ハンドルに対して GlobalFree 関数を呼び出します。
TYMED_GDI	ハンドルに対して DeleteObject 関数を呼び出します。
TYMED_ENHMF	拡張メタファイルを削除します。
TYMED_MFPICT	含まれている hMF を DeleteMetaFile 関数で削除し、その後ハンドル自体を GlobalFree に渡します。
TYMED_FILE	ディスクファイルを削除して解放します。ファイル名文字列は標準のメモリ管理機構を使用して解放します。
TYMED_ISTREAM	IStream::Release を呼び出します。
TYMED_ISTORAGE	IStorage::Release を呼び出します。

いずれの場合も、ReleaseStgMedium の呼び出し後は、指定された記憶媒体は無効となり、以後使用できなくなります。

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

各言語での呼び出し定義

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

void ReleaseStgMedium(
    STGMEDIUM* param0
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern void ReleaseStgMedium(
    IntPtr param0   // STGMEDIUM* in/out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Sub ReleaseStgMedium(
    param0 As IntPtr   ' STGMEDIUM* in/out
)
End Sub

' param0 : STGMEDIUM* in/out
Declare PtrSafe Sub ReleaseStgMedium Lib "ole32" ( _
    ByVal param0 As LongPtr)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ReleaseStgMedium = ctypes.windll.ole32.ReleaseStgMedium
ReleaseStgMedium.restype = None
ReleaseStgMedium.argtypes = [
    ctypes.c_void_p,  # param0 : STGMEDIUM* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
ReleaseStgMedium = Fiddle::Function.new(
  lib['ReleaseStgMedium'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : STGMEDIUM* in/out
  ],
  Fiddle::TYPE_VOID)

#[link(name = "ole32")]
extern "system" {
    fn ReleaseStgMedium(
        param0: *mut STGMEDIUM  // STGMEDIUM* in/out
    );
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern void ReleaseStgMedium(IntPtr param0);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_ReleaseStgMedium' -Namespace Win32 -PassThru
# $api::ReleaseStgMedium(param0)

#uselib "OLE32.dll"
#func global ReleaseStgMedium "ReleaseStgMedium" sptr
; ReleaseStgMedium varptr(param0)
; param0 : STGMEDIUM* in/out -> "sptr"

出力引数:

#uselib "OLE32.dll"
#func global ReleaseStgMedium "ReleaseStgMedium" var
; ReleaseStgMedium param0
; param0 : STGMEDIUM* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#func global ReleaseStgMedium "ReleaseStgMedium" sptr
; ReleaseStgMedium varptr(param0)
; param0 : STGMEDIUM* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。