uva_user_info
Purpose
Decrypts the supplied encrypted user and returns the encrypted description and bit-encoded flags for the supplied user.
|
Warning |
You must use the uva_user_info_ex interface instead of this interface if you use the SW_DOMAIN or LOGON_OS_LOCATION attributes to specify the location where a user’s password should be validated. See Password Validation on Windows Systems for more information. |
Prototype
UV_RCODE uva_user_info (
UV_SH uvsh,
UV_PSTR pEncrUserName,
UV_PSTR pEncrDescBuf,
UV_SIZE iDescBufSize,
UV_PFLAGS pUserFlags
);
Parameters
|
Parameter |
Type |
Description |
|
uvsh |
IN |
Session handle |
|
pEncrUserName |
IN |
Pointer to encrypted VPIU name |
|
pEncrDescBuf |
OUT |
Pointer to buffer to receive VPIU description |
|
iDescBufSize |
IN |
Maximum length of VPIU description |
|
pUserFlags |
OUT |
Pointer to returned user information flags value |
Return Values
|
Value |
Description |
|
SW_OK |
Success |
|
ER_NOTFOUND |
Unknown user |
|
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
This interface is used by iProcess to validate a user name as a VPIU, and to determine system related attributes of the user. The TIBCO iProcess Engine currently uses a similar validation when adding users during a Restore operation.
The returned UserFlags will be a bit-encoded value, currently the only defined bits are:
#define SWUV_FLAG_OSUSER 1
If this bit is set for a VPIU, it means there is a corresponding operating system account for that user.