PK_ENTITY_ask_user_field

PK_ERROR_code_t PK_ENTITY_ask_user_field
(
--- received arguments ---
PK_ENTITY_t     entity,      --- entity to receive message

--- returned arguments ---
int      *const user_field   --- user_field values
)


This function returns the user field values for the given entity.


Specific Errors:
    PK_ERROR_no_user_fields        'user_field' option to PK_SESSION_start
                                   not set greater than zero.


The number of integers returned is that set by the 'user_field' option of
PK_SESSION_start.  This number is available via PK_SESSION_ask_user_field_len.

If the user field values have not been explicitly set by
PK_ENTITY_set_user_field then they will all be returned as zero.