Inside Macintosh: Open Transport /

Chapter 3 - Endpoints / Endpoints Reference

Functions / Obtaining Information About an Endpoint

OTGetEndpointInfo

Obtains information about an endpoint that has been opened.

C INTERFACE

OSStatus OTGetEndpointInfo(EndpointRef ref, TEndpointInfo* info);

C++ INTERFACE

OSStatus TEndpoint::GetEndpointInfo(TEndpointInfo* info);

PARAMETERS

ref

The endpoint reference of the endpoint whose characteristics you want to determine.

info

A pointer to a TEndpointInfo structure (page 3-48) that describes the endpoint's mode of service and the size of the buffers you can use to specify address and option information and to hold data.

DESCRIPTION

The OTGetEndpointInfo function returns information about

• the maximum size of buffers used to specify an endpoint's address and option values
• the maximum size of normal and expedited data you can transfer using this endpoint or, for transaction-based endpoints, the maximum size of requests and replies
• the size of data you can transfer when initiating or tearing down a connection
• the services supported by the endpoint
• any additional characteristics of this endpoint

COMPLETION EVENT CODES

T_GETINFOCOMPLETE

0x2000000A

The OTGetEndpointInfo function has completed. The cookie parameter of the endpoint's notifier function contains the info parameter.

VALID STATES

All

SEE ALSO

The OTGetEndpointInfo function returns a TEndpointInfo structure (page 3-48).

To obtain the current state of the endpoint, use the OTGetEndpointState function (described next).