NAME

xdas_disable_filter - disable the specified filter

SYNOPSIS

OM_uint32 das_disable_filter ( 
    OM_uint32				*minor_status,  
    const xdas_audit_ref_t		*das_ref,
    const xdas_buffer_t		*name
);

DESCRIPTION

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

The xdas_disable_filter() function disables the filter specified by name. It sets the state of the filter to disabled. If necessary the disabled state of the filter may require propagation to all XDAS agents managed by a particular instance of the XDAS Interface. The function does not wait upon the successful disabling of all instances of the filter maintained by XDAS agents. The caller must possess the XDAS_AUDIT_CONTROL authority.

If successful, the function returns [XDAS_S_COMPLETE].

The arguments for xdas_disable_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 disabled.

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.