FingerImage.fromFile Method

Module: FingerImage

Definition

Creates an Image from the specified file.

@staticmethod
from_file(filepath: str, pixel_format: PixelFormat) -> FingerImage

Parameters

filepath str
in A string that contains the name of the file from which to create the Image.

pixel_format PixelFormat
in The pixel format into which to convert the input image.

Returns

The newly created finger image.

Exceptions

An error has occurred during Finger Library execution.
static FingerImage fromFile(String? filepath, PixelFormat pixelFormat)

Parameters

filepath String
in A string that contains the name of the file from which to create the Image.

pixelFormat PixelFormat
in The pixel format into which to convert the input image.

Returns

The newly created finger image.

Exceptions

An error has occurred during Finger Library execution.
public static FingerImage FromFile(string filepath, PixelFormat pixelFormat)

Parameters

filepath string
in A string that contains the name of the file from which to create the Image.

pixelFormat PixelFormat
in The pixel format into which to convert the input image.

Returns

The newly created finger image.

Exceptions

An error has occurred during Finger Library execution.
public static FingerImage fromFile(String filepath, PixelFormat pixelFormat) throws FingerException

Parameters

filepath String
in A string that contains the name of the file from which to create the Image.

pixelFormat PixelFormat
in The pixel format into which to convert the input image.

Returns

The newly created finger image.

Exceptions

An error has occurred during Finger Library execution.
public static func fromFile(filepath: String, pixelFormat: PixelFormat) throws -> FingerImage

Parameters

filepath String
in A string that contains the name of the file from which to create the Image.

pixelFormat PixelFormat
in The pixel format into which to convert the input image.

Returns

The newly created finger image.

Exceptions

An error has occurred during Finger Library execution.
int id3FingerImage_FromFile (
    ID3_FINGER_IMAGE hFingerImage,
    const char * filepath,
    id3FingerPixelFormat ePixelFormat)

Parameters

hFingerImage ID3_FINGER_IMAGE
in Handle to the FingerImage object.

filepath const char *
in A string that contains the name of the file from which to create the Image.

in The pixel format into which to convert the input image.

Returns

int
An error code.
See id3FingerError file for the list of possible error codes.