IXpsOMObjectFactory::CreateReadOnlyStreamOnFile method (xpsobjectmodel.h)

Creates a read-only IStream over the specified file.

Syntax

HRESULT CreateReadOnlyStreamOnFile(
  [in]          LPCWSTR filename,
  [out, retval] IStream **stream
);

Parameters

[in] filename

The name of the file to be opened.

[out, retval] stream

A stream over the specified file.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.

Return code Description
S_OK
The method succeeded.
E_POINTER
filename or stream is NULL.
 

This method calls the Packaging API. For information about the Packaging API return values, see Packaging Errors.

Remarks

CreateReadOnlyStreamOnFile is a wrapper method for IOpcFactory::CreateStreamOnFile. It has the same effect as calling the following:

    hr = opcFactory->CreateStreamOnFile (
        fileName,
        OPC_STREAM_IO_READ,
        NULL,
        FILE_ATTRIBUTE_NORMAL,
        &stream);

Requirements

Requirement Value
Minimum supported client Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header xpsobjectmodel.h

See also

IOpcFactory::CreateStreamOnFile

IXpsOMObjectFactory

Packaging Errors

XML Paper Specification

XPS Document Errors