Sun Java System Access Manager 7.1 C API Reference


The Sun Java™ System Access Manager 7.1 2006Q4 C API Reference provides a listing of application programming interfaces (APIs) you can use to enable C applications to access the Sun Java System Access Manager components. The C API Reference includes function descriptions and syntax.

Who Should Use This Book

The C API Reference is intended for use by IT professionals, network administrators and software developers who implement a network access platform using Sun Java System servers and software. It is recommended that readers of this guide are familiar with the following technologies:

Related Books

Access Manager is a component of the Sun Java Enterprise System (Java ES), a software infrastructure that supports enterprise applications distributed across a network or Internet environment. Related documentation is available as follows:

Access Manager Core Documentation

The Access Manager core documentation set contains the following titles:

Updates to the Sun Java System Access Manager 7.1 Release Notes and links to modifications of the core documentation can be found on the Access Manager page at the Sun Java Enterprise System documentation web site. Updated documents will be marked with a revision date.

Sun Java Enterprise System Product Documentation

Useful information can be found in the documentation for the following Sun Java System products:

Accessing Sun Resources Online

For product downloads, professional services, patches, support, and additional developer information, go to:

Related Third-Party Web Site References

Third-party URLs are referenced in this documentation set and provide additional, related information. Sun is not responsible for the availability of third-party Web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources. Sun will not be responsible or liable for any actual or alleged damage or loss caused by or in connection with the use of or reliance on any such content, goods, or services that are available on or through such sites or resources.

Sun Welcomes Your Feedback

Sun Microsystems is interested in improving its documentation and welcomes your comments and suggestions. To share your thoughts, go to and click the Send Comments link at the bottom of the page. In the online form provided, include the document title and part number. The part number is a seven-digit or nine-digit number that can be found on the title page of the book or at the top of the document. For example, the title of this book is Sun Java System Access Manager 7.1 2006Q2 C API Reference, and the part number is 819–4676.

Documentation, Support, and Training

Sun Function 




Download PDF and HTML documents, and order printed documents 

Support and Training

Obtain technical support, download patches, and learn about Sun courses 

Typographic Conventions

The following table describes the typographic changes that are used in this book.

Table P–1 Typographic Conventions

Typeface or Symbol 




The names of commands, files, and directories, and onscreen computer output 

Edit your .login file.

Use ls -a to list all files.

machine_name% you have mail.


What you type, contrasted with onscreen computer output 

machine_name% su



Placeholder: replace with a real name or value 

The command to remove a file is rm filename.


Book titles, new terms, and terms to be emphasized 

Read Chapter 6 in the User's Guide.

Perform a patch analysis.

Do not save the file.

[Note that some emphasized items appear bold online.] 

Shell Prompts in Command Examples

The following table shows the default system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.

Table P–2 Shell Prompts



C shell prompt 


C shell superuser prompt 


Bourne shell and Korn shell prompt 


Bourne shell and Korn shell superuser prompt