INDConnector::GetConnectionData Method

Article
07/02/2010

Retrieves the private data that the peer sends when it accepts or rejects the connection request.

Syntax

HRESULT GetConnectionData(
  [out, optional]      SIZE_T *pInboundReadLimit,
  [out, optional]      SIZE_T *pOutboundReadLimit,
  [out, optional]      VOID *pPrivateData,
  [in, out, optional]  SIZE_T *pPrivateDataLength
);

Parameters

pInboundReadLimit [out, optional]
The inbound read limit of the peer. Use this value when calling the INDConnector::CreateEndpoint method to create an accepting endpoint.
pOutboundReadLimit [out, optional]
The outbound read limit of the peer. Use this value when calling the INDConnector::CreateEndpoint method to create an accepting endpoint.
pPrivateData [out, optional]
The buffer to receive the private data. May be NULL if pPrivateDataLength is zero.
pPrivateDataLength [in, out, optional]
The size, in bytes, of the pPrivateData buffer. If the buffer is too small, the method fails with ND_BUFFER_OVERFLOW and this parameter is set to the required buffer size. If the buffer in too big, the method sets this parameter to the size used on output.

Return Value

When you implement this method, you should return the following return values. If you return others, try to use well-known values to aid in debugging issues.

Return code	Description
ND_SUCCESS	The operation succeeded.
ND_BUFFER_OVERFLOW	The pCalleeData buffer is not large enough to hold all the private data. Partial data was returned up to the size of the buffer. The pPrivateDataLength is updated with the required buffer size.
ND_CONNECTION_INVALID	The endpoint is not connected.
ND_UNSUCCESSFUL	The operation failed.

Remarks

The connecting peer calls this method after the Connect call completes and before calling the INDConnector::CompleteConnect method.

Requirements

Product	Microsoft Message Passing Interface (MS-MPI)
Header	Ndspi.h