setpwent (BPX1SPE, BPX4SPE) — Reset the user database

Function

The setpwent callable service resets the user database for subsequent searching by the getpwent service. The next getpwent service that is used after setpwent starts searching from the beginning of the user database.

Requirements

Operation Environment
Authorization: Supervisor state or problem state, any PSW key
Dispatchable unit mode: Task
Cross memory mode: PASN = HASN
AMODE (BPX1SPE): 31-bit
AMODE (BPX4SPE): 64-bit
ASC mode: Primary mode
Interrupt status: Enabled for interrupts
Locks: Unlocked
Control parameters: All parameters must be addressable by the caller and in the primary address space.

Format

CALL BPX1SPE,(Return_value)

AMODE 64 callers use BPX4SPE.

Parameters

Return_value
Returned parameter
Type:
Integer
Length:
Fullword

The name of a fullword in which the setpwent service returns 0.

Usage notes

The setpwent service is intended to be used to interrupt a sequential search of the user database from the calling task. The getpwent service performs the sequential search. When the setpwent service is called, it resets the search point for the current task in the user database to the beginning. The next getpwent service that is called from this task after this point starts searching the user database from the beginning.

Related services

Characteristics and restrictions

There are no restrictions on the use of the setpwent service.

Examples

For an example using this callable service, see BPX1SPE (setpwent) example.