Previous Topic: authxapi_FreeListValuesNext Topic: UserDefinedFunction Function

SDK Guide › Exits API › authxapi_GetUserInfo Function

authxapi_GetUserInfo Function

Valid on UNIX

The authxapi_GetUserInfo function retrieves a user name when given a CA ControlMinder user's ACEE handle.

If the function succeeds, it returns 0. If it fails, it sets the global variable errno and returns one of the following error codes:

Return Value

ERRNO

Meaning

AUTHXAPI_E_EINVAL

EINVAL

Invalid (NULL) pointers

AUTHXAPI_E_INVOBJ

EINVAL

Invalid object descriptor

AUTHXAPI_E_INVPROP

EINVAL

Invalid property descriptor

AUTHXAPI_E_NOCLASS

ENOENT

Required class not found

AUTHXAPI_E_NOOBJ

ENOENT

Required object not found

AUTHXAPI_E_NOPROP

ENOENT

Required property not found

AUTHXAPI_E_PTYPE

EINVAL

Property type is a list

AUTHXAPI_E_DBERROR

EIO

Suspect corruption of database

AUTHXAPI_E_NOVAL

ENOENT

No value for property associated with this object

 
int authxapi_GetUserInfo (int  seos_handle,
                          char *uname,
                          int  *size);
seos_handle

The handle of the user whose user name you are requesting.

uname

Buffer large enough to contain the user name being returned. Some UNIX systems allow no more than 8 characters per name; others allow more. CA ControlMinder treats users as any other object and allows up to 255 bytes per name.

size

On entry, the size in bytes of the memory area pointed to by uname. On return, the length of the user name string.

Example: Getting User Name String

This example illustrates how you get the user name string.

{
    int rc;
    char name[256];
    int size;
    ...
    size = sizeof (name)
    rc = authxapi_GetUserInfo(seos_handle, name, &size);
        ...
}

Functions for Windows

The API exit functions provided by CA ControlMinder are actually classified as callbacks. They are grouped into two categories: