xil_cis_get_write_invalid(3)

NAME

xil_cis_get_write_invalid − determine whether a CIS is able to continue to be compressed

SYNOPSIS

#include <xil/xil.h>

Xil_boolean xil_cis_get_write_invalid ( XilCis cis);

DESCRIPTION

This function determines whether compression is able to continue for a compressed image sequence (CIS). cis is the CIS that is being compressed. The default value returned by this routine is FALSE, which indicates that the CIS is valid and compression can continue. If a bitstream error occurs during compression, this routine returns TRUE, indicating that the CIS was marked CIS_WRITE_INVALID.

Two types of bitstream errors can occur during compression of a CIS: autorecoverable and non-autorecoverable. An autorecoverable error is one with a predefined method of recovery. A non-autorecoverable error requires user intervention for recovery. When a non-autorecoverable error is detected, the CIS is marked invalid before the user is notified of the error. If a CIS is marked CIS_WRITE_INVALID for compression, no further operations can be performed on this CIS until it is marked valid again. After a non-autorecoverable error occurs, the user can revalidate the CIS in one of two ways: by calling xil_cis_reset(3) to remove any compressed data currently stored in the CIS, or attempting recovery using xil_cis_attempt_recovery(3).

ERRORS

For a complete list of XIL error messages by number, consult Appendix B of the XIL Programmer’s Guide.

EXAMPLES

Determine if an error has occurred in the compression of a CIS:

    XilCis cis;
    XilImage src;
    xil_compress( src, cis );
    /∗ check to see if the cis is still valid. ∗/
    if (xil_cis_get_write_invalid(cis) == TRUE) {
       printf(" There is a problem with this CIS.\n");
    }

Museum