IOpcPart::GetContentStream method (msopc.h)

Article
02/22/2024

Gets a stream that provides read/write access to part content.

Syntax

HRESULT GetContentStream(
  [out, retval] IStream **stream
);

Parameters

[out, retval] stream

A pointer to the IStream interface of a stream that provides read and write access to part content.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.
E_POINTER	The stream parameter is NULL.
CreateFile function error	An HRESULT error code from the CreateFile function, which is returned as a result of attempting to allocate disk space for part data if the package was opened using the OPC_CACHE_ON_ACCESS read flag.
Package Consumption error	An HRESULT error code from the Package Consumption Error Group.
Part URI error	An HRESULT error code from the Part URI Error Group.

Remarks

For more information about parts, see the Open Packaging Conventions Fundamentals and the ECMA-376 OpenXML, 1st Edition, Part 2: Open Packaging Conventions (OPC).

Thread Safety

Packaging objects are not thread-safe.

For more information, see the Getting Started with the Packaging API.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	msopc.h

Share via