APINPRFS

#### Search Results

Search

# APINPRFS

This PAC API lets obtain chunks of lists of user ids for which there are PAC profiles.

APINPRFS corresponds to the Select Profiles function of the menu system. Unlike them, it produces only the user ids, including SYSTEM: the name of the default profile. These user IDs can then be used as input to APINPRF which in turn corresponds to the Add, Display, and Modify Profile functions of the menu system.

APINPRFS can be invoked with:

    CALLNAT 'APINPRFS' API-PARM API-PRFS-PARM

A definition of API-PARM is provided in LDA UGNLPARM in library SYSPACUS.

S | obtain a chunk of a list of user IDs.

The value of API-PARM.API-SUB-FUNC is ignored.

This document covers the following topics:

- Local Data Area UPILPRFS

- API Return Codes

## Local Data Area UPILPRFS

A definition of API-PRFS-PARM is provided in LDA UPILPRFS in library SYSPACUS.

Field Name | Format | I/O
--- | --- | ---
API-PRFS-PARM |  |
PROFILE | A9 | in
PROF-CNT | N3 | in/out
PROF | A8 (1:60) 1* | in/out
API-PAC-AREA | A145 | in/out

1*: This is the proposed default value. Any value equal or greater 1 can be defined by the user.

When APINPRFS is called:

- API-PRFS-PARM.PROFILE should carry a range of profile names or be blank. A blank API-PRFS-PARM.PROFILE has the same effect on the selection as one carrying an initial asterisk.

- [API-PRFS-PARM.PROF-CNT] is made 0, if negative; it is made 60, if greater than 60. It is then interpreted as the maximum number of user ids to be returned; no user ids will be returned, if API-PRFS-PARM.PROF-CNT = 0.

- Normally, API-PRFS-PARM.API-PAC-AREA should be reset when the firstchunk of a list of user ids is wanted. API-PRFS-PARM.API-PAC-AREA should be left untouched for a next call to obtain an immediately following chunk of the same list.

- APINPRFS returns in API-PRFS-PARM.PROF-CNT the number of user ids in the returned chunk; it may be less than the adjusted original value, if the end of the user id list has been reached. If no profile-owning user id satisfying the selection criteria is found or a non-positive [API-PRFS-PARM.PROF-CNT] has been specified then AINPRFS returns 0 in API-PRFS-PARM.PROF-CNT.

- If APINPRFS returns a non-zero [API-PRFS-PARM.PROF-CNT] then it returns the chunk of the list of the profile-owning user ids satisfying the selection criteria in API-PRFS-PARM.PROF(1:[API-PRFS-PARM.PROF-CNT]).

## API Return Codes

APINPRFS returns the following [API-PARM.API-MSG-NO]:

0000 | if at least one profile-owning user id satisfying the selection criteria has been found and a non-final chunk of a list of the profile-owning user ids satisfying the selection criteria is being returned,
1011 | if [API-PARM.API-MAIN-FUNC] other than 'S' has been specified,
7251 | if profile-owning user ids satisfying the selection criteria have been sought but none has been found,
9999 | if at least one profile-owning user id satisfying the selection criteria has been found and a final chunk of a list of the profile-owning user ids satisfying the selectioncriteria is being returned.

### On this page

- Local Data Area UPILPRFS
- API Return Codes