Legacy Document

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

Chapter 26 - Ports Reference / Functions

Getting Information About Ports /

OTFindPort

Obtains information about a port that corresponds to a given port name.

C INTERFACE

Boolean OTFindPort  (OTPortRecord* record, 
                     const char* portName);

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 portName parameter.

portName

The name of the port about which you want information.

function result

See Discussion.

DISCUSSION

The OTFindPort function returns information about a port that corresponds to a given port name. Each port in a system has a unique port name, which you can obtain the OTFindPortByRef function or the OTGetIndexedPort function.

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

You can use the OTGetIndexedPort function to get port information by iterating through all available ports.

SEE ALSO

"Obtaining Port Information"