aboutsummaryrefslogtreecommitdiff
path: root/doc/html/_sources/appdev/refs/api/krb5_parse_name.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/_sources/appdev/refs/api/krb5_parse_name.txt')
-rw-r--r--doc/html/_sources/appdev/refs/api/krb5_parse_name.txt74
1 files changed, 74 insertions, 0 deletions
diff --git a/doc/html/_sources/appdev/refs/api/krb5_parse_name.txt b/doc/html/_sources/appdev/refs/api/krb5_parse_name.txt
new file mode 100644
index 000000000000..bbd1a1ac533f
--- /dev/null
+++ b/doc/html/_sources/appdev/refs/api/krb5_parse_name.txt
@@ -0,0 +1,74 @@
+krb5_parse_name - Convert a string principal name to a krb5_principal structure.
+==================================================================================
+
+..
+
+.. c:function:: krb5_error_code krb5_parse_name(krb5_context context, const char * name, krb5_principal * principal_out)
+
+..
+
+
+:param:
+
+ **[in]** **context** - Library context
+
+ **[in]** **name** - String representation of a principal name
+
+ **[out]** **principal_out** - New principal
+
+
+..
+
+
+:retval:
+ - 0 Success
+
+
+:return:
+ - Kerberos error codes
+
+..
+
+
+
+
+
+
+
+Convert a string representation of a principal name to a krb5_principal structure.
+
+
+
+A string representation of a Kerberos name consists of one or more principal name components, separated by slashes, optionally followed by the @ character and a realm name. If the realm name is not specified, the local realm is used.
+
+
+
+To use the slash and @ symbols as part of a component (quoted) instead of using them as a component separator or as a realm prefix), put a backslash () character in front of the symbol. Similarly, newline, tab, backspace, and NULL characters can be included in a component by using **n** , **t** , **b** or **0** , respectively.
+
+
+
+Use :c:func:`krb5_free_principal()` to free *principal_out* when it is no longer needed.
+
+
+
+
+
+
+
+
+
+
+..
+
+
+
+
+
+
+.. note::
+
+ The realm in a Kerberos *name* cannot contain slash, colon, or NULL characters.
+
+
+
+