uva_get_user_identity

Purpose

Returns the encrypted VPIU name that relates to the current processes execution context.

Prototype

UV_RCODE uva_get_user_identity (
   UV_SH uvsh, 
   UV_PSTR pEncrUserNameBuf, 
   UV_SIZE iNameBufSize
);

Parameters

Parameter	Type	Description
uvsh	IN	Session handle
pEncrUserNameBuf	OUT	Pointer to buffer to receive encrypted VPIU name
iNameBufSize	IN	Maximum length of encrypted VPIU name

Return Values

Value	Description
SW_OK	Success
ER_HANDLE	Invalid session handle
ER_PARAM	Invalid parameter(s)
ER_SYSTEM	Generic (undefined) error
ER_TOOBIG	Value is too large for supplied buffer

See Return Values for a complete list of possible return values.

Remarks

If there is no direct mapping between the identity of the execution context and a VPIU, the UVAPI package must supply the name of a compatible VPIU. iProcess will call this interface to determine if the user executing certain iProcess Engine hosted utilities has permissions to perform a requested action.