LoadPageMetadata(Stream,Int32,ImGearLoadOptions) Method

In This Topic

Loads page metadata without decoding pixel data.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Overloads Shared Function LoadPageMetadata( _
   ByVal stream As Stream, _
   ByVal pageNumber As Integer, _
   ByVal options As ImGearLoadOptions _
) As ImGearMetadataHead

'Usage
 
Dim stream As Stream
Dim pageNumber As Integer
Dim options As ImGearLoadOptions
Dim value As ImGearMetadataHead
 
value = ImGearFileFormats.LoadPageMetadata(stream, pageNumber, options)

public static ImGearMetadataHead LoadPageMetadata( 
   Stream stream,
   int pageNumber,
   ImGearLoadOptions options
)

public: static ImGearMetadataHead* LoadPageMetadata( 
   Stream* stream,
   int pageNumber,
   ImGearLoadOptions* options
)

public:
static ImGearMetadataHead^ LoadPageMetadata( 
   Stream^ stream,
   int pageNumber,
   ImGearLoadOptions^ options
)

Parameters

stream: Data stream containing an image.
pageNumber: Zero based page number to load the metadata from.
options: Loading options or null.

Return Value

Page metadata tree.

Exceptions

Exception	Description
System.ArgumentNullException	Thrown if the specified stream is null.
ImageGear.Core.ImGearException	Thrown with ImGearErrorCodes.PAGE_NOT_PRESENT error code if the page with the specified page number does not exist in the image.

Remarks

This method reads the specified image stream from the current position and loads the metadata associated with the specified page. This method does not load the metadata assotiated with a document. This method does not decode the actual pixel data.

Reference

ImGearFileFormats Class
ImGearFileFormats Members
Overload List

Get Product Support