v_rel (BPX1VRL, BPX4VRL) — Release a vnode token

Function

The v_rel service accepts a Vnode_token value that represents a file or a directory and releases that token.

Requirements

Operation	Environment
Authorization:	Supervisor state or problem state, any PSW key
Dispatchable unit mode:	Task
Cross memory mode:	PASN = HASN
AMODE (BPX1VRL):	31-bit
AMODE (BPX4VRL):	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 BPX1VRL,(Vnode_token,
              OSS,
              Return_value,
              Return_code,
              Reason_code)

AMODE 64 callers use BPX4VRL with the same parameters.

Parameters

Vnode_token

Supplied parameter

Type:: Token
Length:: 8 bytes

The name of an 8-byte area that contains a vnode token that is to be released.

OSS

Supplied and returned parameter

Type:: Structure
Length:: OSS#LENGTH (from the BPXYOSS macro)

The name of an area that contains operating-system-specific parameters. This area is mapped by the BPXYOSS macro (see BPXYOSS — Map operating system specific information).

Return_value

Returned parameter

Type:: Integer
Length:: Fullword

The name of a fullword in which the v_rel service returns 0 if the request is successful, or -1 if it is not successful.

Return_code

Returned parameter

Type:: Integer
Length:: Fullword

The name of a fullword in which the v_rel service stores the return code. The v_rel service returns Return_code only if Return_value is -1. See z/OS UNIX System Services Messages and Codes for a complete list of possible return code values. The v_rel service can return one of the following values in the Return_code parameter:

Return_code	Explanation
EINVAL	Parameter error; for example, Vnode_token has already been released. The following reason codes can accompany the return code: JRVTokenFreed, JRWrongPID, JRStaleVnodeTok, JRInvalidVnodeTok, JRInvalidOSS.

Reason_code

Returned parameter

Type:: Integer
Length:: Fullword

The name of a fullword in which the v_rel service stores the reason code. The v_rel service returns a Reason_code only if Return_value is -1. Reason_code further qualifies the Return_code value. See z/OS UNIX System Services Messages and Codes for the reason codes.

Usage notes

The vnode token is no longer valid and cannot be used for subsequent requests after the v_rel service has successfully processed it.
All vnode tokens that are obtained from other operations must be released by calling this service.

Related services

v_reg (BPX1VRG, BPX4VRG) — Register a process as a server

Characteristics and restrictions

A process must be registered as a server before the v_rel service is permitted; see v_reg (BPX1VRG, BPX4VRG) — Register a process as a server.

Examples

For an example using this callable service, see BPX1VRL, BPX4VRL (v_rel).