v_pathconf (BPX1VPC, BPX4VPC) — Get pathconf information for a directory or file

Function

The v_pathconf service accepts a vnode token that represents a file or a directory and returns the current values of options that are associated with that file or directory in the output PCFG structure that is defined in the BPXYPCF macro.

Requirements

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

AMODE 64 callers use BPX4VPC 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 represents the directory or file for which to obtain pathconf information.

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.

PCFG_length

Supplied parameter

Type:: Integer
Length:: Fullword

The name of a fullword that contains the length of the PCFG parameter; see Mapping macros in z/OS UNIX System Services Programming: Assembler Callable Services Referencefor the mapping of this field).

PCFG

Returned parameter

Type:: Structure
Length:: Specified by the PCFG_length parameter.

The name of an area in which the pathconf information is to be returned. This area is mapped by the BPXYPCF macro.

Attr_length

Supplied parameter

Type:: Integer
Length:: Fullword

The name of a fullword that contains the length of the Attr parameter.

Attr

Returned parameter

Type:: Structure
Length:: Specified by the Attr_length parameter

The name of an area in which the attributes of the file or directory are to be returned. This area is mapped by the BPXYATTR macro.

Return_value

Returned parameter

Type:: Integer
Length:: Fullword

The name of a fullword in which the v_pathconf service returns the length of the output PCFG 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_pathconf service stores the return code. The v_pathconf service returns Return_code only if Return_value is -1. The v_pathconf service can return one of the following values in the Return_code parameter:

Return_code	Explanation
EINVAL	Parameter error; for example, a supplied area was too small. The following reason codes can accompany the return code: JRSmallAttr, JrInvalidAttr, JRBuffLenInvalid, JrVTokenFreed, JrWrongPID, JRStaleVnodeTok, JRInvalidVnodeTok, JRInvalidOSS
EPERM	The operation is not permitted. The caller of the service is not registered as a server.

Reason_code

Returned parameter

Type:: Integer
Length:: Fullword

The name of a fullword in which the v_pathconf service stores the reason code. The v_pathconf service returns Reason_code only if Return_value is -1. Reason_code further qualifies the Return_code value.

Usage notes

The buffer contents that are returned by the v_pathconf service are mapped by the BPXYPCF macro.

Related services

Characteristics and restrictions

A process must be registered as a server before the v_pathconf service is permitted.

Examples

For an example using this callable services, see BPX1VPC, BPX4VPC (v_pathconf).