ホーム › System.Com.StructuredStorage › StgCreateStorageEx

StgCreateStorageEx

関数

指定形式と属性で新しいストレージオブジェクトを作成する。

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

シグネチャ

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

HRESULT StgCreateStorageEx(
    LPCWSTR pwcsName,   // optional
    STGM grfMode,
    STGFMT stgfmt,
    DWORD grfAttrs,
    STGOPTIONS* pStgOptions,   // optional
    PSECURITY_DESCRIPTOR pSecurityDescriptor,   // optional
    const GUID* riid,
    void** ppObjectOpen
);

パラメーター

名前

型

方向

説明

pwcsName

LPCWSTR

inoptional

作成するファイルのパスへのポインター。この値は解釈されずにファイルシステムへ渡されます。相対名または NULL を指定できます。NULL の場合は、一意の名前を持つ一時ファイルが割り当てられます。NULL 以外の場合、文字列の長さは MAX_PATH 文字を超えてはなりません。

Windows 2000: CreateFile 関数とは異なり、"\?" プレフィックスを使用して MAX_PATH の制限を超えることはできません。

grfMode

STGM

新しいストレージオブジェクトを開くときに使用するアクセスモードを指定する値。詳細については、STGM 定数を参照してください。呼び出し元が STGM_CREATE または STGM_CONVERT と共にトランザクションモードを指定した場合、上書きまたは変換は、ルートストレージに対してコミット操作が呼び出されたときに実行されます。ルートストレージオブジェクトに対して IStorage::Commit が呼び出されない場合、ファイルの以前の内容が復元されます。トランザクションモードでファイルが上書きまたは変換される際にはスナップショットのコピーが必要となるため、STGM_CREATE および STGM_CONVERT を STGM_NOSNAPSHOT フラグと組み合わせることはできません。

stgfmt

STGFMT

ストレージファイルの形式を指定する値。詳細については、STGFMT 列挙型を参照してください。

grfAttrs

DWORD

stgfmt パラメーターの値によって決まる値。

パラメーターの値	意味
STGFMT_DOCFILE	0、または FILE_FLAG_NO_BUFFERING。詳細については、CreateFile を参照してください。pStgOptions で指定されたファイルのセクターサイズが、基になるディスクの物理セクターサイズの整数倍でない場合、この操作は失敗します。
stgfmt のその他のすべての値	0 でなければなりません。

pStgOptions

STGOPTIONS*

inoutoptional

pStgOptions パラメーターは、stgfmt パラメーターに STGFMT_DOCFILE が設定されている場合にのみ有効です。stgfmt パラメーターに STGFMT_DOCFILE が設定されている場合、pStgOptions は STGOPTIONS 構造体を指します。この構造体は、セクターサイズなどのストレージオブジェクトの機能を指定します。このパラメーターには NULL を指定でき、その場合は既定のセクターサイズ 512 バイトでストレージオブジェクトが作成されます。NULL 以外の場合、ulSectorSize メンバーには 512 または 4096 のいずれかを設定する必要があります。4096 を設定した場合、grfMode パラメーターに STGM_SIMPLE を指定することはできません。usVersion メンバーは StgCreateStorageEx を呼び出す前に設定しておく必要があります。詳細については、STGOPTIONS を参照してください。

pSecurityDescriptor

PSECURITY_DESCRIPTOR

inoptional

ファイルの作成時に ACL を設定できるようにします。NULL 以外の場合は、SECURITY_ATTRIBUTES 構造体へのポインターである必要があります。ファイルに ACL を設定する方法については、CreateFile を参照してください。

Windows Server 2003、Windows 2000 Server、Windows XP、および Windows 2000 Professional: 値は NULL でなければなりません。

riid

GUID*

返されるインターフェイスポインターのインターフェイス識別子 (IID) を指定する値。この IID には、IStorage インターフェイスまたは IPropertySetStorage インターフェイスのものを指定できます。

ppObjectOpen

void**

out

新しいストレージオブジェクト上のインターフェイスへのポインターを受け取る、インターフェイスポインター変数へのポインター。操作が失敗した場合は NULL が格納されます。

戻り値の型: HRESULT

公式ドキュメント

IStorage インターフェイスまたは IPropertySetStorage インターフェイスに対して提供された実装を使用して、新しいストレージオブジェクトを作成します。

戻り値

この関数は、HRESULT にラップされたファイルシステムエラーやシステムエラーを返すこともあります。詳細については、Error Handling Strategies および Handling Unknown Errors を参照してください。

解説(Remarks)

アプリケーションが自身のファイルを変更するとき、通常は元のファイルのコピーを作成します。StgCreateStorageEx 関数は、そのコピーを作成する方法の 1 つです。この関数は、暗号化ファイルシステム (EFS) の複製 API と間接的に連携して動作します。この関数を使用する場合は、STGOPTIONS 構造体でファイルストレージのオプションを設定する必要があります。

StgCreateStorageEx は StgCreateDocfile 関数のスーパーセットであり、新しいコードではこちらを使用してください。構造化ストレージに対する今後の機能拡張は、StgCreateStorageEx 関数を通じて公開されます。サポートされるプラットフォームについては、以下の「要件」セクションを参照してください。

StgCreateStorageEx 関数は、システムが提供する構造化ストレージの実装のいずれかを使用して、新しいストレージオブジェクトを作成します。この関数を使用すると、IStorage の複合ファイル実装、IPropertySetStorage の複合ファイル実装、または IPropertySetStorage の NTFS 実装を取得できます。

新しいファイルが作成されるとき、使用されるストレージ実装は、指定したフラグと、ファイルが格納されるドライブの種類によって異なります。詳細については、STGFMT 列挙型を参照してください。

StgCreateStorageEx は、ファイルが存在しない場合はファイルを作成します。ファイルが既に存在する場合は、grfMode パラメーターで指定する STGM_CREATE、STGM_CONVERT、STGM_FAILIFTHERE の各フラグによって、その後の動作が決まります。これらの値の詳細については、STGM 定数を参照してください。ダイレクトモードでは、grfMode パラメーターに STGM_READ モードを指定することはできません (ダイレクトモードは STGM_TRANSACTED フラグを指定しないことで示されます)。この関数を使用して既存のファイルを開くことはできません。代わりに StgOpenStorageEx 関数を使用してください。

StgCreateStorageEx 関数を使用すると、構造化ストレージドキュメントのルートストレージや、プロパティセットをサポートする任意のファイルのプロパティセットストレージにアクセスできます。STGFMT の値ごとにどの IID がサポートされるかについては、STGFMT のドキュメントを参照してください。

この関数で NTFS のプロパティセット実装にアクセスするためにファイルを作成した場合、特別な共有規則が適用されます。詳細については、IPropertySetStorage-NTFS 実装を参照してください。

複合ファイルをトランザクションモード (STGM_TRANSACTED を指定) かつ読み取り専用モード (STGM_READ を指定) で作成した場合、返されたストレージオブジェクトに変更を加えること自体は可能です。たとえば IStorage::CreateStream を呼び出すことができます。ただし、IStorage::Commit を呼び出してそれらの変更をコミットすることはできません。そのため、そうした変更は失われます。

STGM_SIMPLE を指定すると、複数のストリームを持ちストレージを持たない複合ファイル実装を必要とするアプリケーションという、限定的ではあるものの頻繁に使用されるケースにおいて、はるかに高速な複合ファイルオブジェクトの実装が得られます。詳細については、STGM 定数を参照してください。STGM_SIMPLE を指定した場合に STGM_TRANSACTED を指定することはできません。

シンプルモードは IStorage のすべてのメソッドをサポートするわけではありません。具体的には、シンプルモードでサポートされる IStorage のメソッドは CreateStream、Commit、SetClass と、COM の IUnknown のメソッドである QueryInterface、AddRef、Release です。さらに、SetElementTimes は NULL の名前を指定した場合にサポートされ、アプリケーションがルートストレージに時刻を設定できるようになっています。IStorage のその他のメソッドはすべて STG_E_INVALIDFUNCTION を返します。

grfMode パラメーターに STGM_TRANSACTED を指定し、pwcsName パラメーターで指定した名前のファイルがまだ存在しない場合、ファイルはただちに作成されます。アクセス制御されたファイルシステムでは、呼び出し元は、複合ファイルが作成されるファイルシステムのディレクトリに対する書き込み権限を持っている必要があります。STGM_TRANSACTED を指定せずに STGM_CREATE を指定した場合、同じ名前の既存のファイルは、新しいファイルを作成する前に破棄されます。

StgCreateStorageEx では、pwcsName パラメーターに NULL 値を渡すことで、一時的な複合ファイルを作成することもできます。ただし、これらのファイルが一時的であるのは、システムによって付けられた一意の名前 (おそらくユーザーにとっては意味を持たない名前) を持つという意味においてのみです。grfMode パラメーターに STGM_DELETEONRELEASE を指定していない限り、使用が終わった一時ファイルを削除するのは呼び出し元の責任です。これらのフラグの詳細については、STGM 定数を参照してください。

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

各言語での呼び出し定義

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

HRESULT StgCreateStorageEx(
    LPCWSTR pwcsName,   // optional
    STGM grfMode,
    STGFMT stgfmt,
    DWORD grfAttrs,
    STGOPTIONS* pStgOptions,   // optional
    PSECURITY_DESCRIPTOR pSecurityDescriptor,   // optional
    const GUID* riid,
    void** ppObjectOpen
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int StgCreateStorageEx(
    [MarshalAs(UnmanagedType.LPWStr)] string pwcsName,   // LPCWSTR optional
    uint grfMode,   // STGM
    uint stgfmt,   // STGFMT
    uint grfAttrs,   // DWORD
    IntPtr pStgOptions,   // STGOPTIONS* optional, in/out
    IntPtr pSecurityDescriptor,   // PSECURITY_DESCRIPTOR optional
    ref Guid riid,   // GUID*
    IntPtr ppObjectOpen   // void** out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function StgCreateStorageEx(
    <MarshalAs(UnmanagedType.LPWStr)> pwcsName As String,   ' LPCWSTR optional
    grfMode As UInteger,   ' STGM
    stgfmt As UInteger,   ' STGFMT
    grfAttrs As UInteger,   ' DWORD
    pStgOptions As IntPtr,   ' STGOPTIONS* optional, in/out
    pSecurityDescriptor As IntPtr,   ' PSECURITY_DESCRIPTOR optional
    ByRef riid As Guid,   ' GUID*
    ppObjectOpen As IntPtr   ' void** out
) As Integer
End Function

' pwcsName : LPCWSTR optional
' grfMode : STGM
' stgfmt : STGFMT
' grfAttrs : DWORD
' pStgOptions : STGOPTIONS* optional, in/out
' pSecurityDescriptor : PSECURITY_DESCRIPTOR optional
' riid : GUID*
' ppObjectOpen : void** out
Declare PtrSafe Function StgCreateStorageEx Lib "ole32" ( _
    ByVal pwcsName As LongPtr, _
    ByVal grfMode As Long, _
    ByVal stgfmt As Long, _
    ByVal grfAttrs As Long, _
    ByVal pStgOptions As LongPtr, _
    ByVal pSecurityDescriptor As LongPtr, _
    ByVal riid As LongPtr, _
    ByVal ppObjectOpen As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

StgCreateStorageEx = ctypes.windll.ole32.StgCreateStorageEx
StgCreateStorageEx.restype = ctypes.c_int
StgCreateStorageEx.argtypes = [
    wintypes.LPCWSTR,  # pwcsName : LPCWSTR optional
    wintypes.DWORD,  # grfMode : STGM
    wintypes.DWORD,  # stgfmt : STGFMT
    wintypes.DWORD,  # grfAttrs : DWORD
    ctypes.c_void_p,  # pStgOptions : STGOPTIONS* optional, in/out
    wintypes.HANDLE,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR optional
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppObjectOpen : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
StgCreateStorageEx = Fiddle::Function.new(
  lib['StgCreateStorageEx'],
  [
    Fiddle::TYPE_VOIDP,  # pwcsName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # grfMode : STGM
    -Fiddle::TYPE_INT,  # stgfmt : STGFMT
    -Fiddle::TYPE_INT,  # grfAttrs : DWORD
    Fiddle::TYPE_VOIDP,  # pStgOptions : STGOPTIONS* optional, in/out
    Fiddle::TYPE_VOIDP,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR optional
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppObjectOpen : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn StgCreateStorageEx(
        pwcsName: *const u16,  // LPCWSTR optional
        grfMode: u32,  // STGM
        stgfmt: u32,  // STGFMT
        grfAttrs: u32,  // DWORD
        pStgOptions: *mut STGOPTIONS,  // STGOPTIONS* optional, in/out
        pSecurityDescriptor: *mut core::ffi::c_void,  // PSECURITY_DESCRIPTOR optional
        riid: *const GUID,  // GUID*
        ppObjectOpen: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int StgCreateStorageEx([MarshalAs(UnmanagedType.LPWStr)] string pwcsName, uint grfMode, uint stgfmt, uint grfAttrs, IntPtr pStgOptions, IntPtr pSecurityDescriptor, ref Guid riid, IntPtr ppObjectOpen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_StgCreateStorageEx' -Namespace Win32 -PassThru
# $api::StgCreateStorageEx(pwcsName, grfMode, stgfmt, grfAttrs, pStgOptions, pSecurityDescriptor, riid, ppObjectOpen)

#uselib "OLE32.dll"
#func global StgCreateStorageEx "StgCreateStorageEx" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; StgCreateStorageEx pwcsName, grfMode, stgfmt, grfAttrs, varptr(pStgOptions), pSecurityDescriptor, varptr(riid), ppObjectOpen   ; 戻り値は stat
; pwcsName : LPCWSTR optional -> "sptr"
; grfMode : STGM -> "sptr"
; stgfmt : STGFMT -> "sptr"
; grfAttrs : DWORD -> "sptr"
; pStgOptions : STGOPTIONS* optional, in/out -> "sptr"
; pSecurityDescriptor : PSECURITY_DESCRIPTOR optional -> "sptr"
; riid : GUID* -> "sptr"
; ppObjectOpen : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLE32.dll"
#cfunc global StgCreateStorageEx "StgCreateStorageEx" wstr, int, int, int, var, sptr, var, sptr
; res = StgCreateStorageEx(pwcsName, grfMode, stgfmt, grfAttrs, pStgOptions, pSecurityDescriptor, riid, ppObjectOpen)
; pwcsName : LPCWSTR optional -> "wstr"
; grfMode : STGM -> "int"
; stgfmt : STGFMT -> "int"
; grfAttrs : DWORD -> "int"
; pStgOptions : STGOPTIONS* optional, in/out -> "var"
; pSecurityDescriptor : PSECURITY_DESCRIPTOR optional -> "sptr"
; riid : GUID* -> "var"
; ppObjectOpen : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#cfunc global StgCreateStorageEx "StgCreateStorageEx" wstr, int, int, int, sptr, sptr, sptr, sptr
; res = StgCreateStorageEx(pwcsName, grfMode, stgfmt, grfAttrs, varptr(pStgOptions), pSecurityDescriptor, varptr(riid), ppObjectOpen)
; pwcsName : LPCWSTR optional -> "wstr"
; grfMode : STGM -> "int"
; stgfmt : STGFMT -> "int"
; grfAttrs : DWORD -> "int"
; pStgOptions : STGOPTIONS* optional, in/out -> "sptr"
; pSecurityDescriptor : PSECURITY_DESCRIPTOR optional -> "sptr"
; riid : GUID* -> "sptr"
; ppObjectOpen : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。