File Server Environment NCPs

File Server Environment NCPs enable clients to set certain server parameters and return information about servers. Specifically, these NCPs allow clients to enable or disable transaction tracking, to prohibit or allow users to log in, to set the server time and date, to broadcast messages to a group of workstations, to clear a connection, and to down the server. They also enable clients to retrieve information about the file system, the transaction tracking system, physical disks, disk channels, volumes, disk caches, LAN I/Os, file and record locks, semaphores, connections, and tasks.

To safeguard the server from unauthorized access, most NCPs in this section require the client to have OPERATOR rights and some require the client to have SUPERVISOR rights. A client has OPERATOR rights if the object by which the client is logged in is listed in (or is security equivalent to an object that is listed in) the FILE_SERVER object's OPERATORS property.

Likewise, a calling station has SUPERVISOR rights if the object by which the station is logged in is the SUPERVISOR object or is security equivalent to the SUPERVISOR object. (See the introduction to the Bindery Services chapter for details about the SUPERVISOR and FILE_SERVER objects and the OPERATORS property.) If a client does not have sufficient rights to make a call, the No Console Rights completion code (0xC6) is returned.

Each server is listed in its own bindery as a bindery object of type FILE_SERVER (See the introduction to the Bindery Services chapter). The server object has an OPERATORS property which contains the object IDs of those objects that have OPERATOR rights (also referred to as console rights).

The NetWare FCONSOLE utility implements several of the protocols in this section.

Check Console Privileges 0x2222 23 200

v2.x v3.x v4.x v5.x

• • • •

Request Format

	Offset	Content				Type
	(request header)
	6	FunctionCode	(23)		byte
	7	SubFuncStrucLen	(1)		word (Hi-Lo)
	9	SubFunctionCode (200)		byte

Reply Format

	Offset	Content				Type
	(reply header)

Completion Code

	0	0x00	Successful
	198	0xC6	No Console Rights

Remarks

This NCP allows a station to determine whether it has console privileges on the target server. If it does, the Successful completion code will be returned. If it does not, the No Console Rights completion code will be returned.

Clear Connection Number 0x2222 23 254

v2.x v3.x v4.x v5.x

• • •

Request Format

	Offset	Content				Type
	(request header)
	6	FunctionCode	(23)		byte
	7	SubFuncStrucLen	(5)		word (Hi-Lo)
	9	SubFunctionCode (254)		byte
	10	ConnectionNumber		long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)

Completion Code

	0	0x00	Successful
	198	0xC6	No Console Rights
	253	0xFD	Bad Station Number

Remarks

This NCP logs out the specified station. Any resources or files the station is using are released and the station's service connection is broken. The station must re-establish a service connection and log in before it can resume work on the file server.

If the calling station lacks supervisor privileges, the No Console Rights completion code is returned and the target station is not affected.

This call is equivalent to typing "CLEAR #" at the NetWare v2.x file server console or the CLEAR STATION # at the NetWare 3.x or 4.x file server console; the pound symbol (#) represents the connection number of the station to be cleared.

Clear Connection Number (old) 0x2222 23 210

v2.x v3.x v4.x v5.x

• • • •

Request Format

	Offset	Content				Type
	(request header)
	6	FunctionCode	(23)		byte
	7	SubFuncStrucLen	(2)		word (Hi-Lo)
	9	SubFunctionCode (210)		byte
	10	ConnectionNumber		byte

Reply Format

	Offset	Content				Type
	(reply header)

Completion Code

	0	0x00	Successful
	198	0xC6	No Console Rights
	253	0xFD	Bad Station Number

Remarks

This call logs out the specified station. Any resources or files the station is using are released and the station's service connection is broken. The station must re-establish a service connection and log in before it can resume work on the file server.

If the calling station lacks supervisor privileges, the No Console Rights completion code is returned and the target station is not affected.

See Also

Clear Connection Number (0x2222 23 254)

Disable File Server Login 0x2222 23 203

v2.x v3.x v4.x v5.x

• • • •

Request Format

	Offset	Content				Type
	(request header)
	6	FunctionCode	(23)		byte
	7	SubFuncStrucLen	(1)		word (Hi-Lo)
	9	SubFunctionCode (203)		byte

Reply Format

	Offset	Content				Type
	(reply header)

Completion Code

	0	0x00	Successful
	198	0xC6	No Console Rights

Remarks

This NCP allows an operator to instruct the server to refuse new login requests. This call is usually made during some crucial time, such as before taking the server down.

Caution should be used with this call. If, after making the call, the operator loses or destroys his or her service connection to the file server, he or she cannot create a new connection and, therefore, cannot log in again. If no other user on the server has operator privileges, the server must be brought down from the console connected to the server and rebooted before any new users (including the operator) can access it.

If the calling station lacks operator privileges, the No Console Rights completion code is returned and the server's log state remains unchanged.

See Also

Enable File Server Login (0x2222 23 204)

cobra Login Status (0x2222 23 205)

Down File Server (0x2222 23 211)

Disable Transaction Tracking 0x2222 23 207

v2.x v3.x v4.x v5.x

• • • •

Request Format

	Offset	Content				Type
	(request header)
	6	FunctionCode	(23)		byte
	7	SubFuncStrucLen	(1)		word (Hi-Lo)
	9	SubFunctionCode (207)		byte

Reply Format

	Offset	Content				Type
	(reply header)

Completion Code

	0	0x00	Successful
	198	0xC6	No Console Rights

Remarks

This NCP allows an operator to disable the Transaction Tracking functions of an SFT server. Typically, an operator will disable Transaction Tracking when a volume containing the transaction file is filled to capacity. Then, to make space on the volume, the operator (or other users) will move or remove unnecessary files from the volume. The operator can re-enable Transaction Tracking by using the Enable Transaction Tracking NCP (0x2222 23 208).

If the calling station does not have operator privileges, the No Console Rights completion code is returned and the server's Transaction Tracking status remains unchanged.

NOTE: This NCP has no effect on the Transaction Tracking system (TTS is always enabled) in NetWare v4.11 or greater.

See Also

Enable Transaction Tracking (0x2222 23 208)

Down File Server 0x2222 23 211

v2.x v3.x v4.x v5.x

• • • •

Request Format

	Offset	Content				Type
	(request header)
	6	FunctionCode	(23)		byte
	7	SubFuncStrucLen	(2)		word (Hi-Lo)
	9	SubFunctionCode (211)		byte
	10	ForceFlag			byte

Reply Format

	Offset	Content				Type
	(reply header)

Completion Code

	0	0x00	Successful
	198	0xC6	No Console Rights
	255	0xFF	Failure

Remarks

This NCP allows a supervisor to take down a file server from a remote console.

If the ForceFlag field is zero, the server determines whether any stations have file server files open. If any files are in use or open, a Failure completion code (0xFF) is returned, and the server does not go down. If no files are open or in use, the server shuts down, and a Successful completion code is returned.

If the ForceFlag is 0xFF, the server shuts down. All open files are automatically closed, and all unfinished transactions are automatically backed out.

If the calling station does not have supervisor privileges, the No Console Rights completion code is returned and the server does not go down.

See Also

Disable File Server Login (0x2222 23 203)

cobra Login Status (0x2222 23 205)

Enable File Server Login (0x2222 23 204)

Enable File Server Login 0x2222 23 204

v2.x v3.x v4.x v5.x

• • • •

Request Format

	Offset	Content				Type
	(request header)
	6	FunctionCode	(23)		byte
	7	SubFuncStrucLen	(1)		word (Hi-Lo)
	9	SubFunctionCode (204)		byte

Reply Format

	Offset	Content				Type
	(reply header)

Completion Code

	0	0x00	Successful
	198	0xC6	No Console Rights

Remarks

This NCP allows an operator to instruct the server to begin accepting new login requests from clients. Clients that have already logged in will continue to receive service.

Enabling the server's log state also unlocks the Supervisor's account if it has been locked because of intruder detection.

If the calling station does not have operator priviliges, the No Console Rights completion code is returned, and the file server's log state remains unchanged.

See Also

Disable File Server Login (0x2222 23 203)

Enable Transaction Tracking 0x2222 23 208

v2.x v3.x v4.x v5.x

• • • •

Request Format

	Offset	Content				Type
	(request header)
	6	FunctionCode	(23)		byte
	7	SubFuncStrucLen	(1)		word (Hi-Lo)
	9	SubFunctionCode (208)		byte

Reply Format

	Offset	Content				Type
	(reply header)

Completion Code

	0	0x00	Successful
	198	0xC6	No Console Rights

Remarks

This NCP allows an operator to re-enable the Transaction Tracking functions of an SFT file server. The Transaction Tracking system can be disabled manually using the Disable Transaction Tracking call, or automatically by the server when the transaction volume becomes full. After freeing space on the transaction volume for the transaction files, the operator can use this call to re-enable Transaction Tracking.

If the calling station does not have operator privileges, the No Console Rights completion code is returned. The server's transaction status remains unchanged.

NOTE: This NCP has no effect on the Transaction Tracking system (TTS is always enabled) in NetWare v4.11 or greater.

See Also

Disable Transaction Tracking (0x222 23 207)

Get Connection's Open Files 0x2222 23 235

v2.x v3.x v4.x v5.x

• • •

Request Format

	Offset	Content				Type
	(request header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(5)		word (Hi-Lo)
	 9	SubFunctionCode (235)		byte
	10	ConnectionNumber		word (Lo-Hi)
	12	LastRecordSeen			word (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	 8	NextRequestRecord		word (Lo-Hi)
	10	NumberOfRecords			word (Lo-Hi)

		(repeats NumberOfRecords times)

	12	TaskNumber			word (Lo-Hi)
	14	LockType			byte
	15	AccessControl			byte
	16	LockFlag			byte
	17	VolumeNumber			byte
	18	DOSParentDirectoryEntry		long (Lo-Hi)
	22	DOSDirectoryEntry	   	long (Lo-Hi)
	26	ForkCount			byte
	27	NameSpace			byte
	28	NameLen				byte
	29	FileName			byte[NameLen]
	.	.									.
	.	.									.

Completion Code

  0		0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights
253	0xFD	Bad Station Number

Remarks

This NCP returns information about the files currently open by the specified ConnectionNumber. The call should be made iteratively.

The following information is repeated NumberOfRecords times.

TaskNumber indicates the task number within the workstation that has the file open.

LockType contains bit flags indicating the file's lock status:

LockType Bits
7	6	5	4	3	2	1	0	Definition
x	x	x	x	x	x	x	1	Locked
x	x	x	x	x	x	1	x	Open shareable
x	x	x	x	x	1	x	x	Logged
x	x	x	x	1	x	x	x	Open normal
x	1	x	x	x	x	x	x	TTS holding lock
1	x	x	x	x	x	x	x	Transaction flag set on this file

AccessControl contains the bit flags indicating the connection's access rights for the file as follows:

AccessControl Bits
7	6	5	4	3	2	1	0	Definition
x	x	x	x	x	x	x	1	Open for read by this client
x	x	x	x	x	x	1	x	Open for write by this client
x	x	x	x	x	1	x	x	Deny read requests from other stations
x	x	x	x	1	x	x	x	Deny write requests from other stations
x	x	x	1	x	x	x	x	File detached
x	x	1	x	x	x	x	x	TTS holding detach
x	1	x	x	x	x	x	x	TTS holding open

LockFlag indicates the type of lock on the file as follows:

Value	Definition
0x00	Not locked
0xFE	Locked by a file lock
0xFF	Locked by Begin Share File Set

VolumeNumber identifies the file's volume in a Volume Table on the file server. The Volume Table contains information about each file server volume.

DirectoryEntry contains the file path relative to this directory. This value is NOT a directory handle.

NOTE: The parent directory entry and directory entry returned are DOS directory entries. The name space that is returned applies to the FileName and does not imply that the directory entries are name space specific.

FileName is the null-terminated filename.

See Also

Get Connection's Task Information (0x2222 23 234)

Get Connections Using A File (0x2222 23 236)

Get Connection's Open Files (old) 0x2222 23 219

v2.x v3.x v4.x v5.x

•

Request

	Offset	Content				Type
	(Request Header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(5)		word (Hi-Lo)
	 9	SubFunctionCode	(219)		byte
	10	ConnectionNumber		word (Lo-Hi)
	12	LastRecordSeen			word (Lo-Hi)

Reply

Offset Content Type (Reply Header) 8 NextRequestRecord word (Lo-Hi) 10 NumberOfRecords byte (repeats NumberOfRecords times) 11 TaskNumber byte 12 LockType byte 13 AccessControl byte 14 LockFlag byte 15 VolumeNumber byte 16 DirectoryEntry word 18 FileName byte[14] . . . . . .

Completion Code

  0		0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights
253	0xFD	Bad Station Number

Remarks

This is an old NetWare 286 v2.1 call that has been replaced by the NetWare 386 v3.0 call, Get Connection's Open Files (0x2222 23 235).

This v2.1 call returns information about the files currently open by the specified ConnectionNumber. The call should be made iteratively.

The following information is repeated NumberOfRecords times.

TaskNumber indicates the task number within the workstation that has the file open.

LockType contains bit flags indicating the file's lock status:

LockType Bits
7	6	5	4	3	2	1	0	Definition
x	x	x	x	x	x	x	1	Locked
x	x	x	x	x	x	1	x	Open shareable
x	x	x	x	x	1	x	x	Logged
x	x	x	x	1	x	x	x	Open normal
x	1	x	x	x	x	x	x	TTS holding lock
1	x	x	x	x	x	x	x	Transaction flag set on this file

AccessControl contains the bit flags indicating the connection's access rights for the file as follows:

AccessControl Bits
7	6	5	4	3	2	1	0	Definition
x	x	x	x	x	x	x	1	Open for read by this client
x	x	x	x	x	x	1	x	Open for write by this client
x	x	x	x	x	1	x	x	Deny read requests from other stations
x	x	x	x	1	x	x	x	Deny write requests from other stations
x	x	x	1	x	x	x	x	File detached
x	x	1	x	x	x	x	x	TTS holding detach
x	1	x	x	x	x	x	x	TTS holding open

LockFlag indicates the type of lock on the file as follows:

Value	Definition
0x00	Not locked
0xFE	Locked by a file lock
0xFF	Locked by Begin Share File Set

VolumeNumber identifies the file's volume in a Volume Table on the file server. The Volume Table contains information about each file server volume.

DirectoryEntry contains the file path relative to this directory. This value is NOT a directory handle.

FileName is the null-terminated filename.

See Also

Get Connection's Open Files (0x2222 23 235)

Get Connection's Task Information (old) (0x2222 23 218)

Get Connection's Task Information (0x2222 23 234)

Get Connections Using A File (old) (0x2222 23 220)

Get Connections Using A File (0x2222 23 236)

Get Connection Usage Statistics (0x2222 23 229)

Get File System Statistics (0x2222 23 212)

Get Connection's Semaphores 0x2222 23 241

v2.x v3.x v4.x v5.x

• • •

Request Format

	Offset	Content				Type
	(request header)
	6	FunctionCode	(23)		byte
	7	SubFuncStrucLen	(5)		word (Hi-Lo)
	9	SubFunctionCode (241)		byte
	10	ConnectionNumber		word (Lo-Hi)
	12	LastRecordSeen			word (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	 8	NextRequestRecord		word (Lo-Hi)
	10	NumberOfSemaphores		word (Lo-Hi)

		(repeats NumberOfSemaphores times)

	12	OpenCount			word (Lo-Hi)
	14	SemaphoreValue			word (Lo-Hi)
	16	TaskNumber			word (Lo-Hi)
	17	SemaphoreNameLen		byte
	18	SemaphoreName			byte[SemaphoreNameLen]
	.		.			.
	.		.			.

Completion Code

  0	0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights
253	0xFD	Bad Station Number

Remarks

This function allows an operator to get a list of the semaphores that a connection is using. Because a connection may be using more semaphores than the server can report in one reply message, this call can be made iteratively.

On the first call, LastRecordSeen should be set to zero. If the server returns a NextRequestRecord value that is non-zero, the server has not reported all the information. The calling program should repeat the request using the value returned in the NextRequestRecord as the new value for LastRecordSeen.

This process should be repeated until a reply packet with NextRequestRecord set to zero is received or until the Completion Code is not zero. When NextRequestRecord is zero, no more information is avaliable on the specified connection.

The server returns a NumberOfSemaphores indicating the status of semaphores that the target connection is using. The NumberOfSemaphores returned is recorded in NumberOfSemaphores. Each semaphore record contains the following information:

OpenCount contains the number of connections that have this semaphore open for use.

SemaphoreValue is the current value of the semaphore. A negative value is (normally interpreted as) the number of workstations waiting for the service represented by the semaphore. A positive value indicates the number of free resources available in the resource pool governed by the semaphore.

TaskNumber contains the number of the connection's task that is using the semaphore.

SemaphoreNameLen contains the length of the semaphore name.

SemaphoreName contains the name of the semaphore.

See Also

Get Semaphore Information (0x2222 23 242)

Get Connection's Semaphores (old) 0x2222 23 225

v2.x v3.x v4.x v5.x

•

Request Format

	Offset	Content				Type
	(Request Header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(5)		word (Hi-Lo)
	 9	SubFunctionCode (225)		byte
	10	ConnectionNumber		word (Lo-Hi)
	12	LastRecordSeen			word (Lo-Hi)

Reply Format

	Offset	Content				Type
	(Reply Header)
	 8	NextRequestRecord		word (Lo-Hi)
	10	NumberOfSemaphores		word (Lo-Hi)

		(repeats NumberOfSemaphores times)

	12	OpenCount			word (Lo-Hi)
	14	SemaphoreValue			byte
	15	TaskNumber			byte
	16	SempahoreNameLen		byte
	17	SemaphoreName			byte[SempahoreNameLen1]
	.		.			.
	.		.			.

Completion Code

  0		0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights
253	0xFD	Bad Station Number

Remarks

On the first call, LastRecordSeen should be set to zero. If the server returns a NextRequestRecord value that is non-zero, then the server has not reported all the information. The calling program should repeat the request using the value returned in the NextRequestRecord as the new value for LastRecordSeen.

This process should be repeated until a reply packet with NextRequestRecord set to zero is received or until the Completion Code is not zero. When NextRequestRecord is zero, there is no more information avaliable on the specified connection.

OpenCount indicates the number of connections that have this semaphore open for use.

TaskNumber contains the number of the connection's task that is using the semaphore.

SemaphoreNameLen contains the length of the semaphore name.

SemaphoreName contains the name of the semaphore.

See Also

Get Connection's Semaphores (0x2222 23 241)

Get Connection's Task Information 0x2222 23 234

v2.x v3.x v4.x v5.x

• • •

Request Format

	Offset	Content				Type
	(request header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(5)		word (Hi-Lo)
	 9	SubFunctionCode (234)		byte
	10	ConnectionNumber		word (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	 8	LockStatus			byte
	 9	WaitRecord			structure
	??	NumberOfActiveTasks		byte

		(repeats NumberOfActiveTasks times)

	??	TaskNumber			word (Lo-Hi)
	??	TaskState			byte

Completion Code

  0	0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights
253	0xFD	Bad Station Number

Remarks

Given the ConnectionNumber, this call allows an operator to retrieve control information about the current lock status of the connection's active tasks. The format of the information returned depends in part on the value returned in Connection Status.

On return, the LockStatus field will contain one of the following values:

Value	Definition
0	Normal (connection free to run)
1	Connection waiting on a physical record lock
2	Connection waiting on a file lock
3	Connection waiting on a logical record lock
4	Connection waiting on a semaphore

The Wait Record contains information about the current lock state of the target connection. If the target connection is waiting for a lock request to be serviceable, then the Wait Record contains information about the resource for which the connection is waiting. The Wait Record format varies depending on the value of LockStatus.

If LockStatus = 0, Wait Record includes

When LockStatus is 0, no Wait Record field exists in the reply message.

If LockStatus = 1, Wait Record includes

		byte		waitingTaskNumber
		word (Lo-Hi)	beginAddress
		word (Lo-Hi)	endAddress
		byte		volumeNumber
		word (Lo-Hi)	directoryEntry
		byte		lockedName (filename)

If LockStatus = 2, Wait Record includes

		byte		waitingTaskNumber
		byte		volumeNumber
		word (Lo-Hi)	directoryEntry
		byte		lockedName (file name)

If LockStatus = 3, Wait Record includes

		byte		waitingTaskNumber
		byte		lockedName (record name)

If LockStatus = 4, Wait Record includes

		byte		waitingTaskNumber
		byte		lockedName (semaphore name)

Number Of Active Tasks indicates the number of Task and Task State pairs to follow.

Task(#) indicates the task number for which information is to be returned.

Task State(#) is the task's state at the time of the request. The following states are defined:

Value	State
0x00	Normal task
0x01	TTS explicit transaction in progress
0x02	TTS implicit transaction in progress
0x04	Shared file set lock in progress

See Also

Get Connections Using A File (0x2222 23 236)

Get Connection's Open Files (0x2222 23 235)

Get Connection Usage Statistics 0x2222 23 229

v2.x v3.x v4.x v5.x

•

Request Format

	Offset	Content				Type
	(Request Header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(3)		word (Hi-Lo)
	 9	SubFunctionCode (229)		byte
	10	ConnectionNumber		word (Hi-Lo)

Reply Format

	Offset	Content				Type
	(Reply Header)
	 8	SystemIntervalMarker		long (Hi-Lo)
	12	BytesRead			byte[6]
	18	BytesWritten			byte[6]
	24	TotalRequestPackets		long

Completion Code

  0		0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights
253	0xFD	Bad Station Number

Remarks

This call allows a client to get usage statistics for the client's own logical connection. Console operator rights are required to get usage statistics for connections other than the client's.

SystemIntervalMarker indicates how long the server has been up. This field is returned in units of approximately 1/18 of a second and is used to determine the amount of time that has elapsed between consecutive calls. (There are 18.2 ticks per second, or one tick every 0.54945054 of a second.) When this field reaches 0xFFFFFFFF, it wraps back to zero.

Bytes Read is the number of bytes the station has read on the specified ConnectionNumber since the connection was created.

Bytes Written is the number of bytes the station has written on the specified ConnectionNumber since the connection was created.

Bytes Read and Bytes Written are 6-byte low-high numbers.

See Also

Get Connections Using A File (old) (0x2222 23 220)

Get Connections Using A File (0x2222 23 236)

Get Connection's Open Files (old) (0x2222 23 219)

Get Connection's Open Files (0x2222 23 235)

Get Connection's Task Information (old) (0x2222 23 218)

Get Connection's Task Information (0x2222 23 234)

Get File System Statistics (0x2222 23 212)

Get Connections Using A File 0x2222 23 236

v2.x v3.x v4.x v5.x

• • •

Request Format

	Offset	Content				Type
	(request header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(9)		word (Hi-Lo)
	 9	SubFunctionCode (236)		byte
	10	DataStreamNumber		byte
	11	VolumeNumber			byte
	12	DirectoryBase			long (Lo-Hi)
	16	LastRecordSeen			word (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	 8	NextRequestRecord		word (Lo-Hi)
	10	UseCount			word (Lo-Hi)
	12	OpenCount			word (Lo-Hi)
	14	OpenForReadCount		word (Lo-Hi)
	16	OpenForWriteCount		word (Lo-Hi)
	18	DenyReadCount			word (Lo-Hi)
	20	DenyWriteCount			word (Lo-Hi)
	22	Locked				byte
	23	ForkCount			byte
	24	NumberOfRecords			word (Lo-Hi)

		(repeats NumberOfRecords times)

	26	ConnectionNumber1		word (Lo-Hi)
	28	TaskNumber1			word (Lo-Hi)
	30	LockType1			byte
	31	AccessControl1			byte
	32	LockFlag1			byte

Completion Code

  0	0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights

Remarks

This NCP returns all logical connections using the file specified by Directory Handle and File Path. The call must be repeated until NextRequestRecord (returned in the reply message) is 0. The following request parameters are defined:

DataStreamNumber contains the data stream number if the name space is Macintosh. A value of 0 is the resource fork and a value of 1 is the data fork. If DOS, the value is always 0.

VolumeNumber identifies the volume on which the file exists.

DirectoryBase is the Directory entry number, indicating the file or directory path. It is obtained from the File Search Initialize NCP (0x2222 62 --) or Convert Path to Dir Entry (NCP 0x2222 23 244).

LastRecordSeen specifies the last record for which information is being returned. On the first call, LastRecordSeen must be set to zero. Subsequent calls should set LastRecordSeen to the value in NextRequestRecord returned in the previous reply message. If the value in NextRequestRecord is zero, the file server has passed all information to the requesting client.

The following reply parameters are defined:

NextRequestRecord is the value that LastRecordSeen must be set to in the next call.

UseCount indicates the number of tasks that have opened or logged the file.

OpenCount indicates the number of tasks that have the file open.

OpenForReadCount indicates the number of logical connections that have the file open for reading.

OpenForWriteCount indicates the number of logical connections that have the file open for writing.

DenyReadCount indicates the number of logical connections that have denied other connections the right the read from the file.

DenyWriteCount indicates the number of logical connections that have denied other connections the right to write to the file.

Locked indicates whether the file is locked exclusively (0 = not locked exclusively).

The following information is repeated NumberOfRecords times. There is one record for every connection that has used or has tried to use the specified file.

ConnectionNumber indicates the logical connection number of the workstation using the file.

TaskNumber indicates the task number using the file.

LockType contains bit flags indicating the file's lock status:

LockType Bits
7	6	5	4	3	2	1	0	Definition
x	x	x	x	x	x	x	1	Locked
x	x	x	x	x	x	1	x	Open shareable
x	x	x	x	x	1	x	x	Logged
x	x	x	x	1	x	x	x	Open normal
x	1	x	x	x	x	x	x	TTS holding lock
1	x	x	x	x	x	x	x	Transaction flag set on this file

AccessControl contains the bit flags indicating the connection's access rights for the file as follows:

AccessControl Bits
7	6	5	4	3	2	1	0	Definition
x	x	x	x	x	x	x	1	Open for read by this client
x	x	x	x	x	x	1	x	Open for write by this client
x	x	x	x	x	1	x	x	Deny read requests from other stations
x	x	x	x	1	x	x	x	Deny write requests from other stations
x	x	x	1	x	x	x	x	File detached
x	x	1	x	x	x	x	x	TTS holding detach
x	1	x	x	x	x	x	x	TTS holding open

LockFlag indicates the type of lock on the file as follows:

Value	Definition
0x00	Not locked
0xFE	Locked by a file lock
0xFF	Locked by Begin Share File Set

See Also

Get Connection's Task Information (0x2222 23 234)

Get Connection's Open Files (0x2222 23 235)

Get Connections Using A File (old) 0x2222 23 220

v2.x v3.x v4.x v5.x

•

Request Format

	Offset	Content				Type
	(Request Header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(5+PathLen) word (Hi-Lo)
	 9	SubFunctionCode 	(220)	byte
	10	LastRecordSeen			word (Hi-Lo)
	12	DirectoryHandle			byte
	13	PathLen				byte
	14	FilePath			byte[PathLen]

Reply Format

	Offset	Content				Type
	(Reply Header)
	 8	UseCount			word (Hi-Lo)
	10	OpenCount			word (Hi-Lo)
	12	OpenForReadCount		word (Hi-Lo)
	14	OpenForWriteCount		word (Hi-Lo)
	16	DenyReadCount			word (Hi-Lo)
	18	DenyWriteCount			word (Hi-Lo)
	20	NextRequestRecord		word (Hi-Lo)
	22	Locked				byte
	23	NumberOfRecords			byte

		(repeats NumberOfRecords times)

	24	ConnectionNumber1		word (Hi-Lo)
	26	TaskNumber1			byte
	27	LockType1			byte
	28	AccessControl1			byte
	29	1				byte
	.		.			.
	.		.			.

Completion Code

  0	0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights

Remarks

This call returns all logical connections using the file specified by Directory Handle and File Path. The call must be repeated until NextRequestRecord (returned in the reply message) is 0.

UseCount indicates the number of tasks that have opened or logged the file.

OpenCount indicates the number of tasks that have the file open.

OpenForReadCount indicates the number of logical connections that have the file open for reading.

OpenForWriteCount indicates the number of logical connections that have the file open for writing.

DenyReadCount indicates the number of logical connections that have denied other connections the right to read from the file.

DenyWriteCount indicates the number of logical connections that have denied other connections the right to write to the file.

NextRequestRecord is the value that LastRecordSeen must be set to in the next call.

Locked indicates whether the file is locked exclusively (0 = not locked exclusively).

The following information is repeated NumberOfRecords times. There is one record for every connection that has used or has tried to use the specified file.

ConnectionNumber indicates the logical connection number of the workstation using the file.

TaskNumber indicates the task number using the file.

LockType contains bit flags indicating the file's lock status:

LockType Bits
7	6	5	4	3	2	1	0	Definition
x	x	x	x	x	x	x	1	Locked
x	x	x	x	x	x	1	x	Open shareable
x	x	x	x	x	1	x	x	Logged
x	x	x	x	1	x	x	x	Open normal
x	1	x	x	x	x	x	x	TTS holding lock
1	x	x	x	x	x	x	x	Transaction flag set on this file

AccessControl contains the bit flags indicating the connection's access rights for the file as follows:

AccessControl Bits
7	6	5	4	3	2	1	0	Definition
x	x	x	x	x	x	x	1	Open for read by this client
x	x	x	x	x	x	1	x	Open for write by this client
x	x	x	x	x	1	x	x	Deny read requests from other stations
x	x	x	x	1	x	x	x	Deny write requests from other stations
x	x	x	1	x	x	x	x	File detached
x	x	1	x	x	x	x	x	TTS holding detach
x	1	x	x	x	x	x	x	TTS holding open

LockFlag indicates the type of lock on the file as follows:

Value	Definition
0x00	Not locked
0xFE	Locked by a file lock
0xFF	Locked by Begin Share File Set

See Also

Get Connections Using A File (0x2222 23 236)

Get Connection Usage Statistics (0x2222 23 229)

Get Connection's Open Files (old) (0x2222 23 219)

Get Connection's Open Files (0x2222 23 235)

Get Connection's Task Information (old) (0x2222 23 218)

Get Connection's Task Information (0x2222 23 234)

Get File System Statistics (0x2222 23 212)

Get Disk Channel Statistics 0x2222 23 217

v2.x v3.x v4.x v5.x

•

Request Format

	Offset	Content				Type
	(Request Header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(2)		word (Hi-Lo)
	 9	SubFunctionCode (217)		byte
	10	DiskChannelNumber		byte

Reply Format

	Offset	Content				Type
	(Reply Header)
	 8	SystemIntervalMarker		long (Hi-Lo)
	12	ChannelState			word (Hi-Lo)
	14	ChannelSynchronizationState	word (Hi-Lo)
	16	SoftwareDriverType		byte
	17	SoftwareMajorVersionNumber	byte
	18	SoftwareMinorVersionNumber	byte
	19	SoftwareDescription		byte[65]
	84	IOAddressesUsed			word[4] (Hi-Lo)
	92	SharedMemoryAddresses		byte[10]
	102	InterruptNumbersUsed		byte[4]
	106	DMAChannelsUsed			byte[4]
	110	FlagBits			byte
	111	Reserved			byte
	112	ConfigurationDescription	byte[80]

Completion Code

  0	0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights

Remarks

This call allows a client to get the disk channel statistics for the specified Disk Channel Number. A client must have OPERATOR rights in order to make this call.

SystemIntervalMarker indicates how long the server has been up. This field is returned in units of approximately 1/18 of a second and is used to determine the amount of time that has elapsed between consecutive calls. When this field reaches 0xFFFFFFFF, it wraps back to zero.

ChannelState indicates the state of the disk channel:

0x00	Channel is running
0x01	Channel is stopping
0x02	Channel is stopped
0x03	Channel is not functional

ChannelSynchronizationState indicates the control state of the disk channel:

0x00	Channel is not being used
0x02	NetWare is using the channel; no one else wants it
0x04	NetWare is using the channel; someone else wants it
0x06	Someone else is using the channel; NetWare does not need it
0x08	Someone else is using the channel; NetWare needs it
0x0A	Someone else has released the channel; NetWare should use it

SoftwareDriverType contains a number indicating which type of disk driver software that is installed in the disk channel.

SoftwareMajorVersionNumber indicates the major version of the disk driver software installed on the disk channel.

SoftwareMinorVersionNumber indicates the minor version of the disk driver software installed on the disk channel.

SoftwareDescription contains the null-terminated string describing the disk driver software.

IO Addresses Used contains the two addresses the disk driver uses to control the disk channel.

SharedMemoryAddresses contains the two shared memory addresses (offsets).

InterruptNumbersUsed contains the two interrupt numbers the disk driver uses to communicate with the disk channel.

DMAChannelsUsed lists the DMA controllers used by the disk driver to control the disk channel.

ConfigurationDescription is a null-terminated string containing the channel's current IO driver configuration.

See Also

Get Disk Utilization (0x2222 23 14)

Get File System Statistics (0x2222 23 212)

Get Disk Utilization 0x2222 23 14

v2.x v3.x v4.x v5.x

• • • •

Request Format

	Offset	Content				Type
	(request header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(6)		word (Hi-Lo)
	 9	SubFunctionCode (14)		byte
	10	VolumeNumber			byte
	11	TrusteeID			long (Hi-Lo)

Reply Format

	Offset	Content				Type
	(reply header)
	 8	VolumeNumber			byte
	 9	TrusteeID			long (Hi-Lo)
	13	DirectoryCount			word (Hi-Lo)
	15	FileCount			word (Hi-Lo)
	17	ClusterCount			word (Hi-Lo)

Completion Code

	0	0x00	Successful
	150	0x96	Server Out Of Memory
	152	0x98	Disk Map Error
	161	0xA1	Directory I/O Error
	242	0xF2	No Object Read

Remarks

This call allows a client to determine how much physical space the specified Trustee ID is using on the given volume.

DirectoryCount indicates how many directories on the volume are owned by the Trustee ID.

FileCount indicates how many files on the volume are owned by the Trustee ID.

ClusterCount indicates how many physical volume clusters the trustee's files occupy on the volume. To map a cluster count to a count of the number of bytes used, see Get Volume Info With Number (0x2222 18 --) in the File/Directory section.

Clients who are supervisor equivalent can make this call for any object. Clients that do not have supervisor rights can make this call only for the object used when logging in.

See Also

File/Directory NCPs that return information about Volume, Directory, and Object Disk Usage.

Get Drive Mapping Table 0x2222 23 215

v2.x v3.x v4.x v5.x

•

Request Format

	Offset	Content				Type
	(Request Header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(1)		word (Hi-Lo)
	 9	SubFunctionCode (215)		byte

Reply Format

	Offset	Content				Type
	(Reply Header)
	 8	SystemIntervalMarker		long (Hi-Lo)
	12	SFTSupportLevel			byte
	13	LogicalDriveCount		byte
	14	PhysicalDriveCount		byte
	15	DiskChannelTable		byte[5]
	20	PendingIOCommands		word (Hi-Lo)
	22	DriveMappingTable		byte[32]
	54	DriveMirrorTable		byte[32]
	86	DeadMirrorTable			byte[32]
	118	ReMirrorDriveNumber		byte
	119	Filler				byte
	120	ReMirrorCurrentOffset		long (Hi-Lo)
	124	SFTErrorTable			word[60] (Hi-Lo)

Completion Code

  0	0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights

Remarks

This call returns the file server's Drive Mapping Table. If the calling station does not have operator privileges, the Completion Code No Console Rights is returned.

SystemIntervalMarker indicates how long the file server has been up. This field is returned in units of approximately 1/18 of a second and is used to determine the amount of time that has elapsed between consecutive calls. When this field reaches 0xFFFFFFFF, it wraps back to zero.

SFTSupportLevel indicates the SFT level offered by the file server.

SFT Level	Type of SFT
1	the file server offers hot disk error fix.
2	the file server offers disk mirroring and transaction tracking.
3	the file server offers physical file server mirroring.

LogicalDriveCount indicates the number of logical drives attached to the server. If the file server supports SFT Level II or above and disks are mirrored, the Logical Drive Ccount will be lower than the actual number of physical disk subsystems attached to the file server. The file server's operating system considers mirrored disks to be one logical drive.

PhysicalDriveCount indicates the number of physical disk units attached to the server.

DiskChannelTable field is a 5-byte table that indicates which disk channels exists on the server and what their drive types are. (Each channel is 1 byte.) A nonzero value in the DiskChannelTable indicates that the corresponding disk channel exists in the file server. The drive types are:

Dtrive Type Value	Definition
1	XT
2	AT
3	SCSI
4	disk coprocessor
50 to 255	Value Added Disk Drive (VADD).

PendingIOCommands indicates the number of outstanding disk controller commands.

DriveMappingTable is a 32-byte table containing the primary physical drive to which each logical drive is mapped (0xFF = no such logical drive).

DriveMirrorTable is a 32-byte table containing the secondary physical drive to which each logical drive is mapped (0xFF = no such logical drive).

DeadMirrorTable is a 32-byte table containing the secondary physical drive to which each logical drive was last mapped (0xFF = logical drive was never mirrored). This table is used in conjunction with the DriveMirrorTable. If the entry in the DriveMirrorTable shows that a drive is not currently mirrored, the table can be used to determine which drive previously mirrored the logical drive. The DeadMirrorTable is used to remirror a logical drive after a mirror failure.

ReMirrorDriveNumber indicates the physical drive number of the disk currently being remirrored (0xFF = no disk being remirrored).

Filler contains no information.

ReMirrorCurrentOffset contains the block number that is currently being remirrored.

SFTErrorTable is a 60-byte table containing SFT internal error counters.

See Also

Get Disk Channel Statistics (0x2222 23 217)

Get File System Statistics (0x2222 23 212)

File/Directory NCPs that return information about Volume, Directory, and Object Disk Usage.

Get File Server Date And Time 0x2222 20 --

v2.x v3.x v4.x v5.x

• • • •

Request Format

	Offset	Content				Type
	(request header)
	 6	FunctionCode	(20)		byte

Reply Format

Offset Content Type (reply header) 8 Year byte 9 Month byte 10 Day byte 11 Hour byte 12 Minute byte 13 Second byte 14 DayOfWeek byte

Completion Code

	0	0x00	Successful

Remarks

This NCP returns the current date and time being kept by the file server. The system time clock is a 7-byte clock.

Year contains a value from 0 to 179; values from 80 to 99 correspond to the years 1980 through 1999, while values from 100 to 179 correspond to the years 2000 through 2079.

Month contains a value from 1 to 12 corresponding to months January to December.

Day contains a value from 1 to 31 indicating the current day of the month.

Hour contains a value from 0 to 23. Zero (0) is 12 midnight; 23 is 11 p.m.

Minute contains a value from 0 to 59, indicating the minute in the hour.

Second contains a value from 0 to 59, indicating the second in the minute.

Week Day contains a value from 0 to 6. Zero (0) is Sunday; six is Saturday.

This call can be used by any client.

See Also

Set File Server Date And Time (0x2222 23 202)

Get File Server Description Strings 0x2222 23 201

v2.x v3.x v4.x v5.x

• • • •

Request Format

	Offset	Content				Type
	(request header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(1)		word (Hi-Lo)
	 9	SubFunctionCode (201)		byte

Reply Format

	Offset	Content				Type
	(reply header)
	 8	DescriptionStrings		byte[512]

Completion Code

	0	0x00	Successful
	150	0x96	Server Out Of Memory

Remarks

This NCP returns up to 512 bytes of information (in descriptive strings) about the server. Each string is null-terminated. Strings that can be returned might include a company's name, the NetWare version, the revision date, a copyright notice, and so on.

Any client can make this call.

See Also

Get File Server Information (0x2222 23 17)

Get File Server Information 0x2222 23 17

NetWare Linux

v2.x v3.x v4.x v5.x v6.x OES 1 OES 2 OES 11 OES 2015

☑ ☑ ☑ ☑ ☑ ☑ ☑ ☑ ☑

Request Format

	Offset	Content				Type
	(request header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(1)		word (Hi-Lo)
	 9	SubFunctionCode (17)		byte

Reply Format

Offset Content Type (reply header) 8 ServerName byte[48] 56 FileServiceVersion byte 57 FileServiceSubVersion byte 58 MaximumServiceConnections word (Hi-Lo) 60 ConnectionsInUse word (Hi-Lo) 62 NumberMountedVolumes word (Hi-Lo) 64 Revision byte 65 SFTLevel byte 66 TTSLevel byte 67 MaxConnectionsEverUsed word (Hi-Lo) 69 AccountVersion byte 70 VAPVersion byte 71 QueueVersion byte 72 PrintVersion byte 73 VirtualConsoleVersion byte 74 RestrictionLevel byte 75 InternetBridge byte 76 MixedModePathFlag byte 77 LocalLoginInfoCcode byte 78 ProductMajorVersion word (Hi-Lo) 80 ProductMinorVersion word (Hi-Lo) 82 ProductRevisionVersion word (Hi-Lo) 84 OSLanguageID byte 85 64BitOffsetsSupportedFlag byte 86 NCPEngineVersion byte 87 NCPServerPlatform byte 88 ServerCodePageStringLen byte 89 ServerCodePageString byte[20] 109 Reserved byte[27]

Completion Code

	0	0x00	Successful
	150	0x96	Server Out Of Memory

Remarks

This NCP can be used by clients to gain information about a server to which they have a service connection. Any client can use this call without first calling Login.

ServerName contains the server name.

FileServiceVersion contains the major NetWare version number.

FileServiceSubVersion contains the minor NetWare version number.

MaximumServiceConnections contains the maximum number of connection slots that the server has allocated since it has been up. It does not indicate how many connections the server supports. The connections that increment this value may or may not be licensed.

ConnectionsInUse indicates how many connections are currently using the server.

NumberMountedVolumes contains the maximum number of volumes the server supports.

Revision contains the revision level of the NetWare version number.

SFTLevel indicates which SFT level the server operating system is using.

TTSLevel indicates which TTS level the server operating system is using.

MaxConnectionsEverUsed contains the maximum number of "licensed" connections in use at one time. This count will not include connections that have not been "licensed".

AccountVersion contains the Accounting version number.

VAPVersion contains the VAP version number.

QueueVersion contains the Queuing version number.

PrintVersion contains the Print Server version number.

VirtualConsoleVersion contains the Virtual Console version number.

RestrictionLevel contains the Security Restriction version number.

InternetBridge contains the Internet Bridge support version number.

MixedModeFlag is an indicator for mixed mode path handling. If set to 1, mixed mode path handling available.

LocalLoginInfoCcode is the completion code returned from the GetLocalLoginInfo API.

ProductMajorVersion indicates the product major version.

ProductMajorVersion indicates the product minor version.

ProductMajorVersion indicates the product revision version.

OSLanguageID is the language number of the language that is currently enabled on the server.

64BitOffsetsSupportedFlag indicates whether the server supports reading from, 
writing to and locking offsets greater than 4 gig.  See NCPs:
	NCP 87 64 (Read File (64 Bit offset capable))
	NCP 87 65 (Write to a File (64 Bit offset capable))
	NCP 87 66 (Get Current Size of File (64 Bit size capable))
	NCP 87 67 (Log Physical Record (64 Bit offset capable))
	NCP 87 68 (Release Physical Record (64 Bit offset capable))
	NCP 87 69 (Clear Physical Record Set (64 Bit offset capable))
These NCPs are 64 bit enabled on NSS volumes, and provide 32 bit support on legacy volumes.

NCPEngineVersion indicates what version of the NCP Engine is currently running on this server.

typedef enum NCP_EngineVersions_E

{

NCP_EngineVersion_1 = 0x01, /* NetWare 2.x through Linux OES 11 */

NCP_EngineVersion_2 = 0x02 /* Linux OES 2015 (and beyond). Greater than 16TB support.*/

} NCP_EngineVersions_T;

The following NCP verbs were introduced with NCP_EngineVersion_2:

0x2222 22 54 Add User Disk Space Restriction (64Bit Aware)

0x2222 22 55 Get Object Disk Usage and Restrictions (64Bit Aware)

0x2222 22 56 Scan Volume User Disk Restrictions (64Bit Aware)

0x2222 22 57 Set Directory Disk Space Restriction (64Bit Aware)

0x2222 89 41 Get Directory Disk Space Restrictions (64Bit Aware)

0x2222 123 35 Volume Information By Level (64Bit Aware)

NCPServerPlatform indicates the host platform OS that the NCP Engine is currently running on. A zero indicates that it is running on NetWare, and a 1 indicates that it is running on Linux.

The ServerCodePageStringLen is a 1 byte value indicating the length of the ServerCodePageString. The maximum allowed size of ServerCodePageString is 20 bytes. This string is the ASCII representation of the DOSCodePage that the Netware server started up with and which was set from the lconfig.sys file. On a Linux box, this string contains the LC_CTYPE obtained from a call to getenv.

Reserved is reserved for future use.

See Also

Get File Server Description Strings (0x2222 23 201)

Get File Server LAN I/O Statistics 0x2222 23 231

v2.x v3.x v4.x v5.x

•

Request Format

	Offset	Content				Type
	(Request Header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(1)		word (Hi-Lo)
	 9	SubFunctionCode (231)		byte

Reply Format

Offset Content Type (Reply Header) 8 SystemIntervalMarker long 12 ConfiguredMaxRoutingBuffers word 14 ActualMaxUsedRoutingBuffers word 16 CurrentlyUsedRoutingBuffers word 18 TotalFileServicePackets long 22 TurboUsedForFileService word 24 PacketsFromInvalidConnection word 26 BadLogicalConnectionCount word 28 PacketsReceivedDuringProcessing word 30 RequestsReprocessed word 32 PacketsWithBadSequenceNumber word 34 DuplicateRepliesSent word 36 PositiveAcknowledgesSent word 38 PacketsWithBadRequestType word 40 AttachDuringProcessing word 42 AttachWhileProcessingAttach word 44 ForgedDetachedRequests word 46 DetachForBadConnectionNumber word 48 DetachDuringProcessing word 50 RepliesCancelled word 52 PacketsDiscardedByHopCount word 54 PacketsDiscardedUnknownNet word 56 IncomingPacketDiscardedNoDGroup word 58 OutgoingPacketDiscardedNoTurboBuffer word 60 IPXNotMyNetwork word 62 NetBIOSBroadcastWasPropagated long 66 TotalOtherPackets long 70 TotalRoutedPackets long

Completion Code

	  0	0x00	Successful
	150	0x96	Server Out Of Memory

Remarks

This call returns statistical information about packets being received and sent by a file server.

ConfiguredMaxRoutingBuffers indicates the number of routing buffers the network is configured to handle.

ActualMaxUsedRoutingBuffers indicates the maximum number of routing buffers that have been in use simultaneously since the server was brought up.

CurrentlyUsedRoutingBuffers indicates the number of routing buffers that are being used by the server.

TotalFileServicePackets indicates the number of request packets serviced by the file server.

TurboUsedForFileService indicates the number of times file service request packets were stored in routing buffers.

PacketsFromInvalidConnection is the count of all request packets with invalid logical connection numbers. If a packet's logical connection number has not been allocated or the packet's source address doesn't match the address assigned by the file server, the connection number is invalid.

PacketsReceivedDuringProcessing is the number of times a new request is received while the previous request is still being processed. Such packets are received when the client generates a duplicate request while the response to the first request is being sent to the client. In this case, the file server will reprocess the request unnecessarily.

RequestsReprocessed is the count of requests reprocessed by the server. Requests can be reprocessed if the client repeats a request for one that did not receive a response.

PacketsWithBadSequenceNumber is a count of request packets the server received from a connection whose packet sequence number does not not match the current sequence number in the or the next sequence number. (Packets with bad sequence numbers are discarded.)

DuplicateRepliesSent is a count of request packets for which the server had to send a duplicate reply. (Duplicate replies are only sent for requests the server cannot process.)

PositiveAcknowledgesSent is the number of times a client repeats a request that is being serviced.

PacketsWithBadRequestType is a count of request packets containing an invalid request type.

AttachDuringProcessing indicates the number of times the server is requested to create a service connection by clients for which the server is currently processing a request. In this case, the server does not respond to the request currently being processed, and the server recreates a connection with the client (station).

AttachWhileProcessingAttach indicates the number of times the file server receives a request to create a service connection while still servicing the same request received previously. Such duplicate requests are ignored.

ForgedDetachedRequests is a count of requests to terminate a connection whose source address does not match the address the server has assigned to the connection. The detach request is ignored.

DetachForBadConnectionNumber is a count of requests to terminate a connection for a connection number that is not supported by the server.

DetachDuringProcessing indicates the number of requests to terminate a connection while requests are still being processed for the client.

RepliesCancelled indicates the number of replies that were cancelled because the connection was reallocated during processing.

PacketsDiscardedByHopCount indicates the number of packets discarded because they have passed through more than 16 bridges without reaching their destination. (The maximum number of bridges might depend on the particular implementation of NCP, but for NetWare Version 2.x compatibility the maximum number of bridges should be 16.)

PacketsDiscardedUnknownNet indicates the number of packets that were discarded because their destination network is unknown to the server.

IncomingPacketDiscardedNoDGroup indicates the number of incoming packets that were received in a routing buffer that needed to be transferred to a DGroup buffer so that the socket dispatcher could transfer the packet to the correct socket. If no buffers are available, the packet is lost.

OutgoingPacketDiscardedNoTurboBuffer indicates the number of packets the server attempted to send which were lost because no routing buffers were available.

IPXNotMyNetwork is a count of packets received that were destined for the B or C side drivers.

NetBIOSBroadcastWasPropagated is a count of NetBIOS packets circulated through this network.

TotalOtherPackets is a count of all packets received that were not requests for file services.

TotalRoutedPackets is a count of all packets routed by the server.

See Also

Get LAN Driver Configuration Information (0x2222 23 227)

Get File Server Login Status 0x2222 23 205

v2.x v3.x v4.x v5.x

• • • •

Request Format

	Offset	Content				Type
	(request header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(1)		word (Hi-Lo)
	 9	SubFunctionCode (205)		byte

Reply Format

	Offset	Content				Type
	(reply header)
	 8	UserLoginAllowed		byte

Completion Code

	  0	0x00	Successful
	150	0x96	Server Out Of Memory
	251	0xFB	Unknown Request

Remarks

This NCP allows the calling operator to determine whether user logins are currently allowed on the target server.

UserLoginAllowed will be zero if clients cannot log in, and non-zero otherwise.

This NCP does not require console privileges in order to use it.

See Also

Disable File Server Login (0x2222 23 203)

Down File Server (0x2222 23 211)

Get File Server Misc Information 0x2222 23 232

v2.x v3.x v4.x v5.x

•

Request Format

	Offset	Content				Type
	(Request Header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(1)		word (Hi-Lo)
	 9	SubFunctionCode (232)		byte

Reply Format

Offset Content Type (Reply Header) 8 SystemIntervalMarker long 12 ProcessorType byte 13 Reserved byte 14 NumberOfServiceProcesses byte 15 ServerUtilizationPercentage byte 16 ConfiguredMaxBinderyObjects word 18 ActualMaxBinderyObjects word 20 CurrentUsedBinderyObjects word 22 TotalServerMemory word (Hi-Lo) 24 WastedServerMemory word (Hi-Lo) 26 NumberOfDynamicMemoryAreas (1..3) word (Hi-Lo) (repeats NumberOfDynamicMemoryAreas times) 28 TotalDynamicSpace long (Hi-Lo) 32 MaxUsedDynamicSpace long 36 CurrentUsedDynamicSpace long . . . . . .

Completion Code

  0	0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights

Remarks

This call returns miscellaneous information about the file server.

ProcessorType contains a number indicating the processor type:

Value	CPU Type
0	Motorola 68000
1	Intel 8088 or 8086
2	80286

NumberOfServiceProcesses indicates the number of processes in the server that handles incoming service requests.

ServerUtilizationPercentage indicates the current server utilization percentage (0..100). This value is updated once per second.

ConfiguredMaxBinderyObjects indicates the maximum number of bindery objects that the file server will track (0 = unlimited). If disk resource limitation is not installed on the file server, this value is 0 and an unlimited number of bindery objects can be created. Otherwise, this field contains the number that was configured during installation. If this field is nonzero, the file server will not allow the number of bindery objects to exceed this value. The next two fields have no meaning if this field is zero.

ActualMaxBinderyObjects indicates the maximum number of bindery objects that have been used concurrently since the file server came up.

CurrentUsedBinderyObjects indicates the number of bindery objects currently in use on the server.

TotalServerMemory indicates the total amount of memory installed in the server.

WastedServerMemory indicates the amount of memory that the server has determined it is not using.

NumberOfDynamicMemoryAreas (1..3) indicates the number of dynamic memory areas.

The following information is repeated up to 3 times, depending on the value in NumberOfDynamicMemoryAreas.

TotalDynamicSpace indicates the total amount of memory in the dynamic memory area.

MaxUsedDynamicSpace indicates the amount of memory in the dynamic memory area that has been in use since the server was brought up.

CurrentUsedDynamicSpace indicates the amount of memory in the dynamic memory area that is currently in use.

See Also

Get File Server Extended Misc Information (0x2222 23 245)

Get File System Statistics 0x2222 23 212

v2.x v3.x v4.x v5.x

•

Request Format

	Offset	Content				Type
	(Request Header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(1)		word (Hi-Lo)
	 9	SubFunctionCode (212)		byte

Reply Format

Offset Content Type (Reply Header) 8 SystemIntervalMarker long (Hi-Lo) 12 ConfiguredMaxOpenFiles word 14 ActualMaxOpenFiles word 16 CurrentOpenFiles word 18 TotalFilesOpened long 22 TotalReadRequests long 26 TotalWriteRequests long 30 CurrentChangedFATs word 32 TotalChangedFATs long 36 FATWriteErrors word 38 FatalFATWriteErrors word 40 FATScanErrors word 42 ActualMaxIndexedFiles word 44 ActiveIndexedFiles word 46 AttachedIndexedFiles word 48 AvailableIndexedFiles word

Completion Code

  0	0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights

Remarks

This call returns statistics about a server's file system. The call can be used repeatedly to get updated information. The following information is returned:

SystemIntervalMarker indicates how long the file server has been up. This value is returned in units of approximately 1/18 of a second and is used to determine the amount of time that has elapsed between consecutive calls. When this field reaches 0xFFFFFFFF, it wraps back to zero.

Configured Max Open Files indicates the number of files the server can open simultaneously.

Actual Max Open Files indicates the number of files open simultaneously since the server was brought up.

Current Open Files contains the number of files the server has open. This value exceeds the previously recorded Actual Max Open Files count. Current Open Files reflects both files that clients have open and any internal files, such as the bindery, that the file server has open.

Total Files Opened contains the number of files the server has opened since the server was brought up. If this number reaches 0xFFFFFFFF, it wraps back to zero.

Total Read Requests contains the number of read requests the server has received since it was brought up. If this number reaches 0xFFFFFFFF, it wraps back to zero.

Total Write Requests contains the number of write requests the server has received since it was brought up. If this number reaches 0xFFFFFFFF, it wraps back to zero.

Current Changed FATs contains the number of current FAT sectors the file system has modified. FAT sectors are modified when files are extended or truncated.

Total Changed FATs contains the number of FAT sectors the file system has modified since it was brought up.

FAT Write Errors contains the number of disk write errors that have occurred in writing FAT sectors to the disk. All FAT sectors are duplicated on the disk, ensuring that a single disk failure will not result in the loss of the FAT tables. If a FAT sector is lost, its duplicate is automatically used. When a disk write error occurs in both the original and the duplicate of a FAT sector, a fatal error occurs.

Fatal FAT Write Errors contains the number of disk write errors that occurred in both the original and duplicate copy of a FAT sector. Fatal FAT write errors occur because the file system cannot recover the information required to determine where a given file resides on a volume. However, since a copy of the FAT table is kept in memory, the file server continues to function.

FAT Scan Errors contains the number of times an internally inconsistent state existed in the file system.

Actual Max Indexed Files contains the number of indexed files active simultaneously in the server since it was brought up.

Active Indexed Files contains the count of files that are currently active, open, and indexed.

Attached Indexed Files contains the count of indexed files ready for indexing but not ready for use. The attached index files are not currently open, but they have indexes built in memory. These indexes are reused if the attached file is reopened, or rebuilt for other files if needed.

Available Indexed Files contains the count of file indexes that are available for use.

See Also

Get Connections Using A File (old) (0x2222 23 )

Get Connections Using A File (0x2222 23 236)

Get Connection Usage Statistics (0x2222 23 229)

Get Connection's Open Files (0x2222 23 235)

Get Connection's Task Information (old) (0x2222 23 218)

Get Connection's Task Information (0x2222 23 234)

Get LAN Driver Configuration Information 0x2222 23 227

v2.x v3.x v4.x v5.x

•

Request Format

	Offset	Content				Type
	(Request Header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(2)		word (Hi-Lo)
	 9	SubFunctionCode (227)		byte
	10	LANDriverNumber			byte

Reply Format

	Offset	Content				Type
	(Reply Header)
	 8	NetworkAddress			byte[4]
	12	HostAddress			byte[6]
	18	BoardInstalled			byte
	19	OptionNumber			byte
	20	ConfigurationText		byte[160]

Completion Code

  0	0x00	Successful
150	0x96	Server Out Of Memory
255	0xFF	Failure

Remarks

This call returns configuration information for the LAN drivers installed at the file server.

Network Address contains the LAN board number to which the driver is attached.

Host Address indicates the host address of the LAN board the driver is controlling.

Board Installed indicates whether a driver is installed in the specified LAN board. If Board Installed is zero, all fields returned are undefined.

Option Number contains the option selected for the driver during configuration. The selected option number specifies the hardware setup the driver uses when running the LAN board.

Configuration Text is one or more null-terminated strings containing configuration information, such as the LAN board type ("NetWare Ethernet NP600," for example), and the LAN board hardware settings ("IRQ = 9, IOAddress = 300h, DMA = 7," for example).

See Also

Get File Server LAN I/O Statistics (0x2222 23 231)

Get Logical Record Information 0x2222 23 240

v2.x v3.x v4.x v5.x

• • •

Request Format

	Offset	Content				Type
	(request header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(4+LogicalRecordNameLen) word (Hi-Lo)
	 9	SubFunctionCode (240)		byte
	10	LastRecordSeen			word (Lo-Hi)
	12	LogicalRecordNameLen		byte
	13	LogicalRecordName		byte[LogicalRecordNameLen]

Reply Format

	Offset	Content				Type
	(reply header)
	 8	ShareableLockCount		word (Lo-Hi)
	10	UseCount			word (Lo-Hi)
	12	Locked				byte
	13	NextRequestRecord		word (Lo-Hi)
	15	NumberOfRecords			word (Lo-Hi)

		(repeats NumberOfRecords times)

	17	ConnectionNumber		word (Lo-Hi)
	19	TaskNumber			word (Lo-Hi)
	21	LockStatus			byte
	.		.			.
	.		.			.

Completion Code

  0		0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights

Remarks

This NCP returns information about a logical record. The following request parameters are defined:

LastRecordSeen specifies the last record for which information is being returned. On the first call, LastRecordSeen must be set to zero. Subsequent calls should set LastRecordSeen to the value in NextRequestRecord returned in the previous reply message. If the value in NextRequestRecord is zero, the server has passed all information to the requesting client.

LogicalRecordNameLen indicates how long the value in LogicalRecordName is.

LogicalRecordName can be up to 99 bytes long.

LogicalRecordName holds the name of the logical record.

The following reply parameters are defined:

ShareableLockCount indicates the number of logical connections having a shareable lock on the logical record.

UseCount indicates the number of logical connections that have the logical record logged.

Locked indicates whether the logical record is locked exclusively (0 = not locked exclusively).

NextRequestRecord is the value that LastRecordSeen must be set to in the next call.

The following information is returned as many times as NumberOfRecords indicates.

ConnectionNumber indicates the logical connection using the logical record.

TaskNumber indicates the task number within the workstation that has the file open.

LockStatus contains the bit flags indicating the file's lock status, as follows:

LockStatus Bits
7	6	5	4	3	2	1	0	Definition
x	x	x	x	x	x	x	1	Locked exclusive
x	x	x	x	x	x	1	x	Locked shareable
x	x	x	x	x	1	x	x	Logged
x	1	x	x	x	x	x	x	Lock is held by TTS

This requesting client must have console operator rights to make this call.

See Also

Get Logical Records By Connection (0x2222 23 239)

Get Logical Record Information (old) 0x2222 23 224

v2.x v3.x v4.x v5.x

•

Request Format

	Offset	Content				Type
	(Request Header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(4+LogicalRecordNameLen) word (Hi-Lo)
	 9	SubFunctionCode (224)		byte
	10	LastRecordSeen			word
	12	LogicalRecordNameLen		byte
	13	LogicalRecordName		byte[LogicalRecordNameLen]

Reply Format

	Offset	Content				Type
	(Reply Header)
	 8	UseCount			word (Hi-Lo)
	10	ShareableLockCount		word (Hi-Lo)
	12	NextRequestRecord		word
	14	Locked				byte
	15	NumberOfRecords			byte

		(repeats NumberOfRecords times)

	16	ConnectionNumber		word (Hi-Lo)
	18	TaskNumber			byte
	19	LockStatus			byte
	.		.			.
	.		.			.

Completion Code

  0	0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights

Remarks

This call returns information about a logical record.

LogicalRecordNameLength contains the length of the LogicalRecordName (up to 99 bytes).

LogicalRecordName is the name of the logical record.

UseCount indicates the number of logical connections that have the logical record logged.

ShareableLockCount indicates the number of logical connections having a shareable lock on the logical record.

NextRequestRecord is the value that LastRecordSeen must be set to in the next call.

Locked indicates whether the logical record is locked exclusively (0 = not locked exclusively).

The following information is returned as many times as NumberOfRecords indicates.

ConnectionNumber indicates the logical connection using the logical record.

LockStatus contains the bit flags indicating the file's lock status, as follows:

LockStatus Bits
7	6	5	4	3	2	1	0	Definition
x	x	x	x	x	x	x	1	Locked exclusive
x	x	x	x	x	x	1	x	Locked shareable
x	x	x	x	x	1	x	x	Logged
x	1	x	x	x	x	x	x	Lock is held by TTS

This requesting client must have console operator rights to make this call.

See Also

Get Logical Record Information (0x2222 23 240)

Get Logical Records By Connection (old) (0x2222 23 223)

Get Logical Records By Connection (0x2222 23 239)

Get Logical Records By Connection 0x2222 23 239

v2.x v3.x v4.x v5.x

• • •

Request Format

	Offset	Content				Type
	(request header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(5)		word (Hi-Lo)
	 9	SubFunctionCode (239)		byte
	10	TargetConnectionNumber		word (Lo-Hi)
	12	LastRecordSeen			word (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	 8	NextRequestRecord		word (Lo-Hi)
	10	NumberOfRecords			word (Lo-Hi)

		(repeats NumberOfRecords times)

	12	TaskNumber			word (Lo-Hi)
	14	LockStatus			byte
	15	LockNameLen			byte
	16	LockName			byte[LockNameLen]

Completion Code

	  0	0x00	Successful
	150	0x96	Server Out Of Memory
	198	0xC6	No Console Rights
	253	0xFD	Bad Station Number

Remarks

This NCP returns the logical records that a connection has logged with the file server. The following request parameters are defined:

TargetConnectionNumber indicates the logical connection that has the record locked exclusively.

The following reply parameters are defined:

NextRequestRecord is the value that LastRecordSeen must be set to in the next call.

The following information is returned as many times as NumberOfRecords indicates.

TaskNumber indicates which task within the connection that has the record logged.

LockStatus contains the bit flags indicating the file's lock status.

LockStatus Bits
7	6	5	4	3	2	1	0	Definition
x	x	x	x	x	x	x	1	Locked exclusive
x	x	x	x	x	x	1	x	Locked shareable
x	x	x	x	x	1	x	x	Logged
x	1	x	x	x	x	x	x	Lock is held by TTS

LockNameLength indicates the length of the LockName that follows.

LockName is the name of the logical lock.

The requesting client must have console operator rights to make this call.

See Also

Get Logical Record Information (0x2222 23 240)

Get Logical Records By Connection (old) 0x2222 23 223

v2.x v3.x v4.x v5.x

•

Request Format

	Offset	Content				Type
	(Request Header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(5)		word (Hi-Lo)
	 9	SubFunctionCode (223)		byte
	10	TargetConnectionNumber		word
	12	LastRecordSeen			word(Hi-Lo)

Reply Format

Offset Content Type (Reply Header) 8 NextRequestRecord word 10 NumberOfRecords byte (repeats NumberOfRecords times) 11 TaskNumber byte 12 LockStatus byte 13 LockNameLen byte 14 LockName byte[LockNameLen] . . . . . .

Completion Code

  0	0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights
253	0xFD	Bad Station Number

Remarks

This call returns the logical records that a connection has logged with the file server.

TargetConnectionNumber indicates the logical connection that has the record locked exclusively.

LastRecordSeen specifies the last record for which information is being returned. On the first call, LastRecordSeen must be set to zero. Subsequent calls should set LastRecordSeen to the value in NextRequestRecord returned in the previous reply message. If the value in NextRequestRecord is zero, the server has passed all information to the requesting client.

NextRequestRecord is the value that LastRecordSeen must be set to in the next call.

The following information is returned as many times as NumberOfRecords indicates.

TaskNumber indicates which task within the connection that has the record logged.

LockStatus contains the bit flags indicating the file's lock status.

LockStatus Bits
7	6	5	4	3	2	1	0	Definition
x	x	x	x	x	x	x	1	Locked exclusive
x	x	x	x	x	x	1	x	Locked shareable
x	x	x	x	x	1	x	x	Logged
x	1	x	x	x	x	x	x	Lock is held by TTS

LockNameLength indicates the length of the LockName that follows.

LockName is the name of the logical lock.

The requesting client must have console operator rights to make this call.

See Also

Get Logical Record Information (old) (0x2222 23 224)

Get Logical Record Information (0x2222 23 240)

Get Logical Records By Connection (0x2222 23 239)

Get Network Serial Number 0x2222 23 18

v2.x v3.x v4.x v5.x

• • • •

Request Format

	Offset	Content				Type
	(request header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(1)		word (Hi-Lo)
	 9	SubFunctionCode (18)		byte

Reply Format

	Offset	Content			Type
	(reply header)
	 9	ServerSerialNumber		long (Lo-Hi)
	13	ApplicationNumber		word (Lo-Hi)

Completion Code

	  0	0x00	Successful
	150	0x96	Server Out Of Memory

Remarks

This NCP returns a file server's serial number and the application number. The combination of the server's serial number and the application number is unique.

Get Object's Remaining Disk Space 0x2222 23 230

v2.x v3.x v4.x v5.x

• • • •

Request Format

	Offset	Content				Type
	(request header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(5)		word (Hi-Lo)
	 9	SubFunctionCode (230)		byte
	10	ObjectID			long (Hi-Lo)

Reply Format

	Offset	Content				Type
	(reply header)
	 8	SystemIntervalMarker		long (Hi-Lo)
	12	ObjectID			long (Lo-Hi)
	16	UnusedDiskBlocks		long (Hi-Lo)
	20	RestrictionsEnforced		byte

Completion Code

	0	0x00	Successful
	150	0x96	Server Out Of Memory
	198	0xC6	No Console Rights

Remarks

This NCP returns the number of unused disk blocks available to the specified Object ID. A client can only obtain the information for the Object ID by which that client logged in; clients must have console operator rights to make this call for any other Object ID.

The Object ID indicates which Object ID requested the information.

Configured Max Open Files contains the number of files the server can open simultaneously.

Unused Disk Blocks indicates how many blocks the file server has available to allocate to a bindery object.

Restrictions Enforced indicates whether the file server operating system can place limitations on disk resources (0x00 = enforced; 0xFF = not enforced).

Get Physical Record Locks By Connection And File 0x2222 23 237

v2.x v3.x v4.x v5.x

• • •

Request Format

	Offset	Content				Type
	(request header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(22)		word (Hi-Lo)
	 9	SubFunctionCode (237)		byte
	10	TargetConnectionNumber		word (Lo-Hi)
	12	DataStreamNumber		byte
	13	VolumeNumber			byte
	14	DirectoryBase			long (Lo-Hi)
	18	LastRecordSeen			word (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	 8	NextRequestRecord		word (Lo-Hi)
	10	NumberOfLocks			word (Lo-Hi)

		(repeats NumberOfLocks times)

	12	TaskNumber			word (Lo-Hi)
	14	LockType			byte
	15	RecordStart			long (Lo-Hi)
	19	RecordEnd			long (Lo-Hi)

Completion Code

  0	0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights
253	0xFD	Bad Station Number
255	0xFF	No Files Found

Remarks

This NCP returns a logical connection's physical record locks within a file. This call can only be made by a client with console operator rights. The following request parameters are defined:

TargetConnectionNumber indicates the logical connection number of the client using the file.

The DataStreamNumber contains the data stream number if the name space is Macintosh. A value of 0 is the resource fork and a value of 1 is the data fork. If DOS, the value is always 0.

VolumeNumber identifies the volume on which the file exists.

The DirectoryBase is the Directory entry number, indicating the file or directory path. It is obtained from the File Search Initialize NCP (0x2222 62 --).

The following reply parameters are defined:

NextRequestRecord contains the value to be placed in LastRecordSeen for the next iteration of this call. If NextRequestRecord is zero, all information has been returned.

NumberOfLocks indicates the number of physical record locks. It also indicates the number of records to follow. The following information is repeated the number of times indicated by the value in NumberOfLocks.

TaskNumber contains the number of the task that is using the file.

LockStatus contains the bit flags indicating the file's lock status:

LockStatus Bits
7	6	5	4	3	2	1	0	Definition
x	x	x	x	x	x	x	1	Locked exclusive
x	x	x	x	x	x	1	x	Locked shareable
x	x	x	x	x	1	x	x	Logged
x	1	x	x	x	x	x	x	Lock is held by TTS

RecordStart is the byte offset (where the record begins) within the file.

RecordEnd is the byte offset (where the record ends) within the file.

This client must have console operator rights to make this call.

See Also

Get Physical Record Locks By File (0x2222 23 238)

Get Physical Record Locks

By Connection And File (old) 0x2222 23 221

v2.x v3.x v4.x v5.x

•

Request Format

Offset	Content				Type
	(Request Header)
	 6	FunctionCode	(23)	byte
	 7	SubFuncStrucLen	(22)	word (Hi-Lo)
	 9	SubFunctionCode (221)	byte
	10	TargetConnectionNumber	word
	12	LastRecordSeen		word
	14	VolumeNumber		byte
	15	DirectoryID		word
	17	FileName		byte[14]

Reply Format

	Offset	Content			Type
	(Reply Header)
	 8	NextRequestRecord	word
	10	NumberOfLocks	  	byte
	11	Reserved		byte

		(repeats NumberOfLocks times)

	12	TaskNumber1		byte
	13	LockType1		byte
	14	RecordStart1		long(H/L)
	18	RecordEnd1		long(H/L)
	.	.			.
	.	.			.

Completion Code

  0	0x00	Successful
150	0x96	Server Out Of Memory
198	0xC6	No Console Rights
253	0xFD	Bad Station Number
255	0xFF	No Files Found

Remarks

This call returns a logical connection's physical record locks within a file. This call can only be made by a client with console operator rights.

TargetConnectionNumber indicates the logical connection number of the client using the file.

VolumeNumber identifies the volume on which the file exists.

DirectoryID is obtained from the File Search Initialize NCP and indicates the file path that is relative to this directory.

FileName names the file for which information is being requested.

NextRequestRecord contains the value to be placed in LastRecordSeen for the next iteration of this call. If NextRequestRecord is zero, all information has been returned.

NumberOfLocks indicates the number of physical record locks.

NumberOfRecords indicates the number of records to follow.

The following information is repeated the number of times indicated by the value in NumberOfRecords.

TaskNumber contains the number of the task that is using the file.

LockStatus contains the bit flags indicating the file's lock status:

LockStatus Bits
7	6	5	4	3	2	1	0	Definition
x	x	x	x	x	x	x	1	Locked exclusive
x	x	x	x	x	x	1	x	Locked shareable
x	x	x	x	x	1	x	x	Logged
x	1	x	x	x	x	x	x	Lock is held by TTS

RecordStart is the byte offset (where the record begins) within the file.

RecordEnd is the byte offset (where the record ends) within the file.

This client must have console operator rights to make this call.

See Also

Get Physical Record Locks By Connection And File (0x2222 23 237)

Get Physical Record Locks By File (old) (0x2222 23 222)

Get Physical Record Locks By File (0x2222 23 238)

Get Physical Record Locks By File 0x2222 23 238

v2.x v3.x v4.x v5.x

• • •

Request Format

	Offset	Content				Type
	(request header)
	 6	FunctionCode	(23)		byte
	 7	SubFuncStrucLen	(5+PathLen)	  word (Hi-Lo)
	 9	SubFunctionCode (238)		byte
	10	DataStreamNumber	(Fork)	byte
	11	VolumeNumber			byte
	12	DirectoryBase			long (Lo-Hi)
	16	LastRecordSeen			word (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	 8	NextRequestRecord		word (Lo-Hi)
	10	NumberOfLocks			word (Lo-Hi)

		(repeats NumberOfLocks times)

	12	LoggedCount			word (Lo-Hi)
	14	ShareableLockCount	  	word (Lo-Hi)
	16	RecordStart			long (Lo-Hi)
	20	RecordEnd			long (Lo-Hi)
	24	LogicalConnectionNumber		word (Lo-Hi)
	26	TaskNumber			word (Lo-Hi)
	28	LockType			word (Lo-Hi)

Completion Code

	  0	0x00	Successful
	150	0x96	Server Out Of Memory
	198	0xC6	No Console Rights
	253	0xFD	Bad Station Number
	255	0xFF	No Files Found

Remarks

This NCP returns a list of all physical records that are locked in a file. The following request parameters are defined:

The DataStreamNumber contains the data stream number if the name space is Macintosh. A value of 0 is the resource fork and a value of 1 is the data fork. If DOS, the value is always 0.

VolumeNumber identifies the volume on which the file exists.

The DirectoryBase is the Directory entry number, indicating the file or directory path. It is obtained from the File Search Initialize NCP (0x2222 62 --).

LastRecordSeen indicates the last record for which information is being returned. On the first call, LastRecordSeen must be set to zero. Subsequent calls should use the value returned by the file server in NextRequestRecord. If the value in the NextRequestRecord field is zero, the file server has returned all information to the client.

The following reply parameters are defined:

NextRequestRecord contains the value to be placed in the LastRecordSeen field for the next iteration of this call. If NextRequestRecord is zero, all information has been returned.

NumberOfLocks is the number of physical record locks. It also indicates the number of records to follow. The following information is repeated the number of times indicated by the value in NumberOfLocks.

LoggedCount indicates the number of tasks that have the record logged.

ShareableLockCount indicates the number of tasks that have the record locked shareable.

RecordStart is the byte offset (where the record begins) within the file.

RecordEnd is the byte offset (where the record ends) within the file.

LogicalConnectionNumber indicates which logical connection has the record locked exclusively.

TaskNumber contains the task number within the logical connection that has the record locked exclusively.

LockType is a flag indicating the type of lock on the file:

Value	Definition
0x00	Not locked
0xFE	Locked by a file lock
0xFF	Locked by Begin Share File Set

A client must have console operator rights to make this call.

See Also

Get Physical Records Locks By Connection And File (0x2222 23 237)

Get Physical Record Locks By File (old) 0x2222 23 222

v2.x v3.x v4.x v5.x

•

Request Format

	Offset	Content				Type
	(Request Header)
	 6	FunctionCode	(23)		byte
	 7	SubFunctionStrucLen	(5+PathLen) word (Hi-Lo)
	 9	SubFunctionCode 	(222)	byte
	10	LastRecordSeen			word
	12	DirectoryHandle			byte
	13	PathLen				byte
	14	FilePath 			byte[PathLen]

Reply Format

Offset Content Type (Reply Header) 8 NextRequestRecord word 10 NumberOfLocks byte 11 Reserved byte (repeats NumberOfLocks times) 12 LoggedCount word 14 ShareableLockCount word 16 RecordStart long 20 RecordEnd long 24 LogicalConnectionNumber word 26 TaskNumber byte 27 LockType byte . . . . . .

Completion Code

0 0x00 Successful

150 0x96 Server Out Of Memory

198 0xC6 No Console Rights

253 0xFD Bad Station Number

255 0xFF No Files Found

Remarks

This call returns a list of all physical records that are locked in a file.

DirectoryHandle indicates the file path that is relative to this directory.

PathLength indicates the length of File Path.

FilePath is the path and name of the file for which information is being requested.