HP Open Source Security for OpenVMS Volume 3: Kerberos > Chapter 6 KRB5 (Kerberos V5) Application Programming Interface

krb5_get_default_realm— Retrieve the default realm

  Table of Contents

  Glossary

  Index

C Prototype

krb5_error_code krb5_get_default_realm(
krb5_context context,
char **lrealm );

Arguments

context (input) 

The context structure.

lrealm (output) 

A pointer to the default realm.

Description

This routine retrieves the default realm to be used if no user-specified realm is available (for example, to interpret a user-typed principal name with the realm omitted for convenience), setting lrealm with a pointer to the default realm in allocated storage.

It is the caller's responsibility for freeing the allocated storage pointed to be lrealm when it is finished with it.

Return Values

This routine returns the following KRB5 status code:

System errors.