UpdatePageMetadata(Stream,Stream,ImGearMetadataHead) Method

This method has been deprecated. Creates a new file with exact copy of source file's pixel data and with new metadata.

Syntax

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

'Declaration
 
<ObsoleteAttribute("This method will be removed from the public API in a future release. Use UpdateDocumentMetadata to update DICOM metadata.")>
Public Overloads Shared Sub UpdatePageMetadata( _
   ByVal sourceStream As Stream, _
   ByVal destinationStream As Stream, _
   ByVal metadata As ImGearMetadataHead _
)

'Usage
 
Dim sourceStream As Stream
Dim destinationStream As Stream
Dim metadata As ImGearMetadataHead
 
ImGearFileFormats.UpdatePageMetadata(sourceStream, destinationStream, metadata)

[ObsoleteAttribute("This method will be removed from the public API in a future release. Use UpdateDocumentMetadata to update DICOM metadata.")]
public static void UpdatePageMetadata( 
   Stream sourceStream,
   Stream destinationStream,
   ImGearMetadataHead metadata
)

[ObsoleteAttribute("This method will be removed from the public API in a future release. Use UpdateDocumentMetadata to update DICOM metadata.")]
public: static void UpdatePageMetadata( 
   Stream* sourceStream,
   Stream* destinationStream,
   ImGearMetadataHead* metadata
)

[ObsoleteAttribute("This method will be removed from the public API in a future release. Use UpdateDocumentMetadata to update DICOM metadata.")]
public:
static void UpdatePageMetadata( 
   Stream^ sourceStream,
   Stream^ destinationStream,
   ImGearMetadataHead^ metadata
)

Parameters

sourceStream: The data stream, containing source image.
destinationStream: The data stream to which to write result image.
metadata: Metadata to be saved to result file.

Remarks

This method will be removed in future release. For supporting the same functionality it is required to use another overload that takes page number argument. For DICOM file format which does not use page number for page metadata UpdateDocumentMetadata method is recommended.

This method creates a new file with an exact copy of the source file's pixel data and with new metadata. Pixel data is not decoded but copied directly from source to destination file.

This method can be used for updating metadata in an image file without modifying the pixel data. To achieve this, delete the source file after calling this method, and rename result file to the source file name.

Tags that affect decoding of pixel data are transferred from the source file, and not replaced with tags from metadata.

Currently, the method only supports metadata updating in the DICOM file format.

Reference

ImGearFileFormats Class
ImGearFileFormats Members
Overload List
ImGearMetadataHead Class