DocumentImage.reallocate Method

Module: DocumentImage

Definition

Reallocates the internal memory of the Image from parameters.

Note

If the given parameters are the same as the ones of the object, then there is nothing done in this function.

Python

reallocate(self, width: int, height: int, pixel_format: PixelFormat) -> None

Parameters

width int

in The new width, in pixels.

height int

in The new height, in pixels.

pixel_format PixelFormat

in The new pixel format.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

void reallocate(int width, int height, PixelFormat pixelFormat)

Parameters

width int

in The new width, in pixels.

height int

in The new height, in pixels.

pixelFormat PixelFormat

in The new pixel format.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C#

public void Reallocate(int width, int height, PixelFormat pixelFormat)

Parameters

width int

in The new width, in pixels.

height int

in The new height, in pixels.

pixelFormat PixelFormat

in The new pixel format.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public void reallocate(int width, int height, PixelFormat pixelFormat) throws DocumentException

Parameters

width int

in The new width, in pixels.

height int

in The new height, in pixels.

pixelFormat PixelFormat

in The new pixel format.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public func reallocate(width: Int32, height: Int32, pixelFormat: PixelFormat) throws

Parameters

width Int32

in The new width, in pixels.

height Int32

in The new height, in pixels.

pixelFormat PixelFormat

in The new pixel format.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentImage_Reallocate (
    ID3_DOCUMENT_IMAGE hDocumentImage,
    int width,
    int height,
    id3DocumentPixelFormat ePixelFormat)

Parameters

hDocumentImage ID3_DOCUMENT_IMAGE

in Handle to the DocumentImage object.

width int

in The new width, in pixels.

height int

in The new height, in pixels.

ePixelFormat id3DocumentPixelFormat

in The new pixel format.

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.