OleSaveToStream 関数 (ole.h)
IPersistStream インターフェイスを持つオブジェクトを、指定されたストリームに保存します。
構文
OLESTATUS OleSaveToStream(
LPOLEOBJECT unnamedParam1,
LPOLESTREAM unnamedParam2
);
パラメーター
unnamedParam1
ストリームに保存するオブジェクトの IPersistStream インターフェイスへのポインター。 pPStm パラメーターを NULL にすることはできません。
unnamedParam2
オブジェクトを保存するストリーム上の IStream インターフェイスへのポインター。
戻り値
この関数は、成功したS_OKを返します。 その他の可能な値は次のとおりです。
リターン コード | 説明 |
---|---|
|
ディスク領域がないため、オブジェクトを保存できませんでした。 |
|
pPStm パラメーターは NULL です。 |
この関数は、 WriteClassStm 関数または IPersistStream::Save メソッドによって返されるエラー値を返すこともできます。
注釈
この関数を使用すると、 IPersistStream インターフェイスを実装するオブジェクトをストリームに簡単に保存できます。 このストリームでは、オブジェクトの CLSID がデータの前に置きます。 ストリームが取得されると、CLSID は適切なコードをデータに関連付けるのを許可します。 OleSaveToStream 関数は次の処理を行います。
- IPersist::GetClassID メソッドを呼び出して、オブジェクトの CLSID を取得します。
- WriteClassStm 関数を使用して、CLSID をストリームに書き込みます。
- fClearDirty を TRUE に設定して IPersistStream::Save メソッドを呼び出します。これにより、オブジェクト内のダーティ ビットがクリアされます。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | ole.h (Ole2.h を含む) |
Library | Ole32.lib |
[DLL] | Ole32.dll |
API セット | ext-ms-win-com-ole32-l1-1-1 (Windows 8.1 で導入) |