Sun Java System Access Manager 7 2005Q4 C API Reference

am_auth_get_module_instance_names()

Gets the authentication module instances (or plug-ins) configured for an organization, or sub-organization name that was set during the creation of the auth context.

Syntax

#include "am_auth.h"
AM_EXPORT am_status_t
am_auth_get_module_instance_names(am_auth_context_t auth_ctx,
                  am_string_set_t** module_inst_names_ptr);

Parameters

This function takes the following parameters:

auth_ctx

Handle of the auth context.

module_inst_names_ptr

Address of a pointer to am_string_set_t.

Returns

This function returns am_status_t with one of the following values:

AM_SUCCESS

If the submitted requirements were processed successfully.

AM_AUTH_FAILURE

If the authentication process failed.

AM_INVALID_ARGUMENT

If the auth_ctx parameter is NULL.

AM_SERVICE_NOT_INITIALIZED

If the Authentication Service is not initialized.

Details

Supply the address of a pointer to a structure of type am_string_set_t . Module instance names are returned in am_string_set_t. Free the memory allocated for this set by calling am_string_set_destroy() .

Returns NULL if the number of modules configured is zero.