./_Man_Openwin_html/html3/xil

Manual page for xil_open(3)

xil_open, xil_close - open and close an XIL session

SYNOPSIS

#include <xil/xil.h>

XilSystemState xil_open ();

void xil_close (XilSystemState State);

DESCRIPTION

xil_open.3 is used to begin an XIL session. It must be called before any other XIL routine. A single XilSystemState object is created and returned when xil_open.3 is invoked. If the function is successful, a handle to the XilSystemState object is returned. This object can only be destroyed by a subsequent call to xil_close.3 using the specified handle.

When xil_open.3 is called, the XIL library attempts to open and load all of the compute pipelines specified in the machine's XIL configuration files. All of the XIL library's capabilities are enabled after this call.

xil_close (3) is used to end an XIL session. A handle to the XilSystemState object describing the session to be terminated is passed to the function. The XilSystemState system state object and all internal resources associated with the given XIL session are destroyed. XIL objects created during the session at the application's request must be released by the appliction using the appropriate XIL destroy calls. Application writers are expected to destroy the XIL objects they create.

ERRORS

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

EXAMPLES

Open and close the XIL Library:

XilSystemState State;
State = xil_open();
xil_close(State);

NOTES

Multiple calls to xil_open() produce completely separate system states that provide completely separate XIL environments. Objects created in one environment can be used by other environments. This feature is intended to allow layered software that uses the XIL library to be independent from other layered software using the XIL library.