UpdatePageMetadata Method
In This Topic
Updates page metadata without changing pixel data.
Syntax
'Declaration
Public Shared Sub UpdatePageMetadata( _
ByVal As Stream, _
ByVal As Stream, _
ByVal As ImGearMetadataHead, _
ByVal As Integer _
)
'Usage
Dim sourceStream As Stream
Dim destinationStream As Stream
Dim metadata As ImGearMetadataHead
Dim pageNumber As Integer
ImGearFileFormats.UpdatePageMetadata(sourceStream, destinationStream, metadata, pageNumber)
public static void UpdatePageMetadata(
Stream ,
Stream ,
ImGearMetadataHead ,
int
)
public: static void UpdatePageMetadata(
Stream* ,
Stream* ,
ImGearMetadataHead* ,
int
)
public:
static void UpdatePageMetadata(
Stream^ ,
Stream^ ,
ImGearMetadataHead^ ,
int
)
Parameters
- sourceStream
- Data stream containing a source image.
- destinationStream
- Data stream to write the updated image to.
- metadata
- Page metadata tree to be saved to the new image.
- pageNumber
- Zero based page number to update the metadata for.
Exceptions
Exception | Description |
System.ArgumentNullException |
Thrown if the specified stream is null or metadata parameter 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, or the page with the specified
page number represents DICOM vector waveform data.
Thrown with ImGearErrorCodes.CANT_SAVE_FORMAT error code if the metadata cannot be updated due to invalid data in the source stream.
|
See Also