NetGetRIPLMachineInfo or Net32GetRIPLMachineInfo

The NetGetRIPLMachineInfo API retrieves information about a RIPL workstation.

Restrictions

A process with any access authority can call this API with a level of 0 or 1. To call this API with a level of 2, the calling process must have administrator privilege or server operator privilege.

Syntax

#include <ripl.h>
 
NetGetRIPLMachineInfo(pszServername,
          MachineName, sLevel, buf,
          usBuflen, pusBytesAvail);   /* 16 bit */
 
Net32GetRIPLMachineInfo(pszServername,
            MachineName, ulLevel, buf,
            ulBuflen, pulBytesAvail);   /* 32 bit */

Parameters

See Common Parameter Definitions for descriptions of parameters not defined here.

MachineName

(unsigned char LSFAR *) points to an ASCIIZ string containing the name of the RIPL workstation definition for which information is to be retrieved. This pointer cannot be NULL.
sLevel or ulLevel
(16-bit unsigned short or 32-bit unsigned long) must be 0, 1, or 2, specifying the level of detail returned in the ripl_machine_info structure as described in RIPL Machine Data Structures. Level 12 is not valid for this API.
Return Codes

The following table lists the return codes most significant to this API. (See API Return Codes for a complete list of return codes.) ┌──────────────────────────────┬───────┬───────────────────────────────────────┐│SYMBOLICCONSTANT │VALUE│MEANING │
├──────────────────────────────┼───────┼───────────────────────────────────────┤
│ NERR_NotRIPLServer │ 5401 │ The server name specified is not a │
│ │ │ valid remote IPL server. │
├──────────────────────────────┼───────┼───────────────────────────────────────┤
│ NERR_RPL_MAPNotFound │ 5402 │ The RPL.MAP file was not found or │
│ │ │ could not be opened on the remote IPL │
│ │ │ server. │
├──────────────────────────────┼───────┼───────────────────────────────────────┤
│ NERR_RPL_MAPReadError │ 5403 │ An error was detected while reading │
│ │ │ the RPL.MAP file on the remote IPL │
│ │ │ server. │
├──────────────────────────────┼───────┼───────────────────────────────────────┤
│ NERR_MachineNotFound │ 5405 │ The machine definition does not exist │
│ │ │ on the remote IPL server. │
├──────────────────────────────┼───────┼───────────────────────────────────────┤
│ NERR_MACHINESFileNotFound │ 5407 │ An error was detected while reading │
│ │ │ configuration files in the │
│ │ │ IBMLAN\RPL\MACHINES directory tree on │
│ │ │ the remote IPL server. │
├──────────────────────────────┼───────┼───────────────────────────────────────┤
│ NERR_RPLUSERFileNotFound │ 5409 │ An error was detected while reading │
│ │ │ configuration files in the │
│ │ │ IBMLAN\RPLUSER directory tree on the │
│ │ │ remote IPL server. │
├──────────────────────────────┼───────┼───────────────────────────────────────┤
│ NERR_RPLFileNotFound │ 5410 │ An error was detected while reading │
│ │ │ configuration files in the IBMLAN\RPL │
│ │ │ directory tree on the remote IPL │
│ │ │ server. │
├──────────────────────────────┼───────┼───────────────────────────────────────┤
│ NERR_MachineFilesLocked │ 5411 │ Machine configuration files are │
│ │ │ locked by the remote IPL server file │
│ │ │ system. │
├──────────────────────────────┼───────┼───────────────────────────────────────┤
│ NERR_MachNameTooLong │ 5415 │ Machine definition names for DOS or │
│ │ │ FAT file systems cannot exceed 8 │
│ │ │ bytes. │
└──────────────────────────────┴───────┴───────────────────────────────────────┘


Remarks

If you call this API with the buffer length parameter equal to zero, the API returns a value for total bytes available. This technique is useful if you do not know the exact buffer size required.

---

[Back: NetEnumRIPLMachine or Net32EnumRIPLMachine]
[Next: NetSetRIPLMachineInfo or Net32SetRIPLMachineInfo]