encap_install(3) C Library Calls encap_install(3)NAME
encap_install, encap_remove, encap_check - perform operations on Encap
packages
SYNOPSIS
#include <encap.h>
typedef int (*encap_decision_func_t)(ENCAP *encap, encap_source_info_t
*srcinfo, encap_target_info_t *tgtinfo);
int encap_install(ENCAP *encap, encap_decision_func_t decision_func);
int encap_remove(ENCAP *encap, encap_decision_func_t decision_func);
int encap_check(ENCAP *encap, encap_decision_func_t decision_func);
VERSION
This man page documents version 2.3 of libencap.
DESCRIPTION
The encap_install(), encap_remove(), and encap_check() functions can be
used to install, remove, or check the status of the package associated
with encap. If the decision_func argument is not NULL, the function it
points to is called to evaluate the link and override libencap's deci‐
sion about how to handle it. This allows the calling application to
have more fine-grained control over Encap processing.
The decision_func function is called for each file which is processed.
The encap argument is the ENCAP handle associated with the package
being processed. The srcinfo structure is the description of the Encap
source file which is returned by encap_check_source(3). The tgtinfo
structure is the description of the Encap target link which is returned
by encap_check_target(3).
The decision_func function must return one of the following values to
tell libencap how to proceed:
R_RETURN
Fatal error. Stop processing the Encap and return immediately.
R_ERR Non-fatal error. Processing continues with the next file in the
Encap package. (Note that if SRC_REQUIRED is set in
srcinfo->src_flags, a fatal error will result. This case is
handled the same as if decision_func() had returned R_RETURN.)
R_FILEOK
File should be processed normally.
R_SKIP Do not process this file. No error is recorded, and Processing
continues with the next file in the Encap package.
RETURN VALUES
The encap_install(), encap_remove(), and encap_check() functions each
return one of the following values:
ENCAP_STATUS_NOOP
No action was needed.
ENCAP_STATUS_SUCCESS
Operation successful.
ENCAP_STATUS_PARTIAL
Operation partially successful. Some files were processed suc‐
cessfully, but at least one error was encountered.
ENCAP_STATUS_FAILED
Operation failed.
SEE ALSOencap_open(3), encap_check_source(3), encap_check_target(3)University of Illinois Oct 2002 encap_install(3)
