sntl_licensing_identity_new

Library Information

>This API belongs to the Sentinel RMS licensing library.

>The corresponding header is licensing.h.

Description

Returns the identity object for the given application context and attribute object.

Syntax

SNTL_DECLARE(sntl_status_t) sntl_licensing_identity_new (sntl_licensing_app_context_t          *app_context,
                                                         const sntl_licensing_attr_t           *attr,
                                                         sntl_licensing_identity_t             **identity); 

Argument	Description
app_context [in]	Pointer to the application context object created using sntl_licensing_app_context_new.
attr [in]	Pointer to the attribute object set using sntl_licensing_attr_set. The attribute(s) that can be set is (are) described in the next section.
identity [out]	The identity object.

Attributes

The table below provides details about the attribute(s) that can be set:

Attribute for...	Key and Description
Setting the user name	>Attribute Key - SNTL_ATTR_IDENTITY_USERNAME >Sets the user name that needs to be aliased to a different string. >The maximum length of the string is 31 characters. The standard character set includes letters, numbers, and the following symbols: •% (percentage) • . (period) • - (hyphen) • _(underscore).

Returns

The status code SNTL_SUCCESS is returned, if successful. Otherwise, a specific status code is returned indicating the reason for failure. For a complete list of the error codes, see Licensing Library Error and Result Codes