NAME

xdas_get_filter - get named audit filter

SYNOPSIS

OM_uint32 das_get_filter ( 
    OM_uint32				*minor_status, 
    const xdas_audit_ref_t		*das_ref,
    const xdas_buffer_t		*name,
    OM_unit32				*filter_type,
    xdas_buffer_t			*filter_exp,
    xdas_buffer_t			*filter_act,
    OM_uint32				*filter_status
);

DESCRIPTION

xdas_get_filter() is a member of the XDAS Filter Management API Option Conformance class.

The xdas_get_filter() function returns the components of the filter referred to by name. The caller must possess the XDAS_AUDIT_CONTROL authority.

If successful, the function returns [XDAS_S_COMPLETE].

The arguments for xdas_get_filter() are:

minor_status (out)

An implementation specific return status that provides additional information when [XDAS_S_FAILURE] is returned by the function.

das_ref (in)

The handle to the XDAS server, obtained from a previous call to xdas_initialize_session.

name (in)

The name of the filter to be returned.

filter_type (out)

The type of filter. This may be either XDAS_C_SUBMIT or XDAS_C_IMPORT.

filter_exp (out)

The contents of the expression list that determines the events to be selected by this filter.

filter_act (out)

The list of actions to be carried out for events selected by this filter.

filter_status (out)

The enabled or disabled state of the filter. If the filter is enabled then a value of 0 is returned in this parameter, otherwise a value of 1 is returned.

RETURN VALUE

The following XDAS status codes shall be returned:

[XDAS_S_AUTHORIZATION_FAILURE]

The caller does not possess the required authority.

[XDAS_S_COMPLETE]

Successful completion.

[XDAS_S_FAILURE]

An implementation specific error or failure has occurred.

[XDAS_S_INVALID_DAS_REF]

The audit service handle supplied does not point to the audit service.

[XDAS_S_INVALID_FILTER]

The filter name supplied is not known.

[XDAS_S_NOT_SUPPORTED]

The called function is not supported by this implementation.

ERRORS

No other errors are defined.

[??] Some characters or strings that appear in the printed document are not easily representable using HTML.