Inside Macintosh: Open Transport /

Chapter 6 - Configuration Management / Configuration Management Reference

Functions / Getting Information About Ports

OTFindPortByRef

Obtains information about a port that corresponds to its given port reference.

C INTERFACE

Boolean OTFindPortByRef (OTPortRecord* record, 
                         OTPortRef ref);

C++ INTERFACES

None. C++ applications use the C interface to this function.

PARAMETERS

record

A pointer to a port structure that contains information about the port you specified with the ref parameter.

ref

The port reference of the port about which you want information.

DESCRIPTION

The OTFindPortByRef function returns information about a port identified by its port reference. A port reference is a 32-bit value that describes a port's hardware characteristics: its bus and device type, its physical slot number, and, where applicable, its multiport identifier. This identifier differentiates between multiple hardware ports on a given slot.

You must allocate the port structure; the function fills this structure with information about the port indicated by the ref parameter. If the function returns false, the contents of the structure are not significant.

SEE ALSO

For information about finding ports and obtaining a port reference, see the sections "About Port Information" (page 6-5) and "Obtaining Port Information" (page 6-11).

You can use the OTCreatePortRef function (page 6-35) to create a port reference.

The port structure is described in "The Port Structure" (page 6-17).