Merge from vendor branch LIBPCAP:
[dragonfly.git] / crypto / heimdal-0.6.3 / lib / krb5 / krb5_principal_get_realm.cat3
1
2 KRB5_PRINCIPAL_GET_REALM(3)UNIX Programmer's ManualKRB5_PRINCIPAL_GET_REALM(3)
3
4 N\bNA\bAM\bME\bE
5      k\bkr\brb\bb5\b5_\b_p\bpr\bri\bin\bnc\bci\bip\bpa\bal\bl_\b_g\bge\bet\bt_\b_r\bre\bea\bal\blm\bm, k\bkr\brb\bb5\b5_\b_p\bpr\bri\bin\bnc\bci\bip\bpa\bal\bl_\b_g\bge\bet\bt_\b_c\bco\bom\bmp\bp_\b_s\bst\btr\bri\bin\bng\bg - decompose a
6      principal
7
8 L\bLI\bIB\bBR\bRA\bAR\bRY\bY
9      Kerberos 5 Library (libkrb5, -lkrb5)
10
11 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
12      _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*
13      k\bkr\brb\bb5\b5_\b_p\bpr\bri\bin\bnc\bci\bip\bpa\bal\bl_\b_g\bge\bet\bt_\b_r\bre\bea\bal\blm\bm(_\bk_\br_\bb_\b5_\b__\bc_\bo_\bn_\bt_\be_\bx_\bt _\bc_\bo_\bn_\bt_\be_\bx_\bt, _\bk_\br_\bb_\b5_\b__\bp_\br_\bi_\bn_\bc_\bi_\bp_\ba_\bl _\bp_\br_\bi_\bn_\bc_\bi_\bp_\ba_\bl)
14
15      _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*
16      k\bkr\brb\bb5\b5_\b_p\bpr\bri\bin\bnc\bci\bip\bpa\bal\bl_\b_g\bge\bet\bt_\b_c\bco\bom\bmp\bp_\b_s\bst\btr\bri\bin\bng\bg(_\bk_\br_\bb_\b5_\b__\bc_\bo_\bn_\bt_\be_\bx_\bt _\bc_\bo_\bn_\bt_\be_\bx_\bt,
17              _\bk_\br_\bb_\b5_\b__\bp_\br_\bi_\bn_\bc_\bi_\bp_\ba_\bl _\bp_\br_\bi_\bn_\bc_\bi_\bp_\ba_\bl, _\bu_\bn_\bs_\bi_\bg_\bn_\be_\bd _\bi_\bn_\bt _\bc_\bo_\bm_\bp_\bo_\bn_\be_\bn_\bt)
18
19 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
20      These functions return parts of the _\bp_\br_\bi_\bn_\bc_\bi_\bp_\ba_\bl, either the realm or a spe-
21      cific component. The returned string points to data inside the principal,
22      so they are valid only as long as the principal exists.
23
24      The _\bc_\bo_\bm_\bp_\bo_\bn_\be_\bn_\bt argument to k\bkr\brb\bb5\b5_\b_p\bpr\bri\bin\bnc\bci\bip\bpa\bal\bl_\b_g\bge\bet\bt_\b_c\bco\bom\bmp\bp_\b_s\bst\btr\bri\bin\bng\bg() is the compo-
25      nent number to return, from zero to the total number of components minus
26      one. If a the requested component number is out of range, NULL is re-
27      turned.
28
29      These functions can be seen as a replacement for the k\bkr\brb\bb5\b5_\b_p\bpr\bri\bin\bnc\bc_\b_r\bre\bea\bal\blm\bm(),
30      k\bkr\brb\bb5\b5_\b_p\bpr\bri\bin\bnc\bc_\b_c\bco\bom\bmp\bpo\bon\bne\ben\bnt\bt() and related macros, described as intermal in the
31      MIT API specification. A difference is that these functions return
32      strings, not krb5_data. A reason to return krb5_data was that it was be-
33      lieved that principal components could contain binary data, but this be-
34      lief was unfounded, and it has been decided that principal components are
35      infact UTF8, so it's safe to use zero terminated strings.
36
37      It's generally not necessary to look at the components of a principal.
38
39 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
40      krb5_unparse_name(3)
41
42  HEIMDAL                         June 20, 2001                               1