Legacy Document

Inside Macintosh: Networking With Open Transport / Part 2 - Open Transport Reference

Chapter 26 - Ports Reference / Functions

Getting Information About Ports /

OTFindPortByRef

Obtains information about a port identified by its port reference.

C INTERFACE

Boolean OTFindPortByRef(OTPortRecord* record, 
                                         OTPortRef ref);

C++ INTERFACE

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

PARAMETERS

record

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

ref

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

function result

See Discussion.

DISCUSSION

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.

You must allocate the port structure; the function fills this structure with information about the port indicated by the ref parameter.

I f the function returns false, no port exists with the given port reference and the contents of the structure are not significant.

SEE ALSO

"Obtaining Port Information".

The OTCreatePortRef function.