iPXE
Data Fields
image_type Struct Reference

An executable image type. More...

#include <image.h>

Data Fields

char * name
 Name of this image type. More...
 
int(* probe )(struct image *image)
 Probe image. More...
 
int(* exec )(struct image *image)
 Execute image. More...
 
int(* pixbuf )(struct image *image, struct pixel_buffer **pixbuf)
 Create pixel buffer from image. More...
 
int(* asn1 )(struct image *image, size_t offset, struct asn1_cursor **cursor)
 Extract ASN.1 object from image. More...
 
int(* extract )(struct image *image, struct image *extracted)
 Extract archive image. More...
 

Detailed Description

An executable image type.

Definition at line 76 of file image.h.

Field Documentation

◆ name

char* image_type::name

Name of this image type.

Definition at line 78 of file image.h.

Referenced by imgstat().

◆ probe

int( * image_type::probe) (struct image *image)

Probe image.

Parameters
imageImage
Return values
rcReturn status code

Return success if the image is of this image type.

Definition at line 87 of file image.h.

◆ exec

int( * image_type::exec) (struct image *image)

Execute image.

Parameters
imageImage
Return values
rcReturn status code

Definition at line 94 of file image.h.

Referenced by image_exec(), and image_select().

◆ pixbuf

int( * image_type::pixbuf) (struct image *image, struct pixel_buffer **pixbuf)

Create pixel buffer from image.

Parameters
imageImage
pixbufPixel buffer to fill in
Return values
rcReturn status code

Definition at line 102 of file image.h.

Referenced by image_pixbuf().

◆ asn1

int( * image_type::asn1) (struct image *image, size_t offset, struct asn1_cursor **cursor)

Extract ASN.1 object from image.

Parameters
imageImage
offsetOffset within image
cursorASN.1 cursor to fill in
Return values
nextOffset to next image, or negative error

The caller is responsible for eventually calling free() on the allocated ASN.1 cursor.

Definition at line 114 of file image.h.

Referenced by image_asn1().

◆ extract

int( * image_type::extract) (struct image *image, struct image *extracted)

Extract archive image.

Parameters
imageImage
extractedExtracted image
Return values
rcReturn status code

Definition at line 123 of file image.h.

Referenced by image_extract().


The documentation for this struct was generated from the following file: