WindowsDeleteStringBuffer 関数 (winstring.h)

事前に割り当てられた文字列バッファーが HSTRING に昇格されなかった場合は破棄します。

構文

HRESULT WindowsDeleteStringBuffer(
  HSTRING_BUFFER bufferHandle
);

パラメーター

bufferHandle

種類: [入力] HSTRING_BUFFER

破棄するバッファー。 windowsPreallocateStringBuffer 関数の呼び出しによって bufferHandle が割り当てられていない場合、WindowsDeleteStringBuffer 関数は例外を発生させます。

戻り値

型: HRESULT

この関数は、これらの値のいずれかを返すことができます。

リターン コード	説明
S_OK	バッファーが正常に破棄されました。
E_POINTER	bufferHandle は NULL です。

注釈

WindowsPreallocateStringBuffer 関数によって作成されたが、WindowsPromoteStringBuffer 関数によって HSTRING に昇格されていない文字列バッファーを破棄するには、WindowsDeleteStringBuffer 関数を使用します。

メモ 同じバッファー ハンドルを使用 して WindowsDeleteStringBuffer を呼び出した後に WindowsPromoteStringBuffer を呼び出すことは未定義です。

 

例

次のコード例は、 WindowsDeleteStringBuffer 関数の使用方法を示しています。

int main()
{
    HSTRING_BUFFER hStringBuffer = NULL;
    PWSTR strBuffer = NULL;
    HRESULT hr = WindowsPreallocateStringBuffer(10, &strBuffer, &hStringBuffer);

    // You hit a case in which you need to discard the buffer.

    WindowsStringDeleteBuffer(hStringBuffer);
}

要件

要件	値
サポートされている最小のクライアント	Windows 8 [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー	Windows Server 2012 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	winstring.h
Library	RuntimeObject.lib
[DLL]	ComBase.dll

こちらもご覧ください

HSTRING

HSTRING_BUFFER

WindowsPreallocateStringBuffer

WindowsPromoteStringBuffer