RxCeBuildConnection function (rxce.h)

Article
02/22/2024

RxCeBuildConnection establishes a connection between a local RDBSS connection address and a given remote address.

Syntax

NTSTATUS RxCeBuildConnection(
            IN PRXCE_ADDRESS                  pLocalAddress,
  [in]      IN PRXCE_CONNECTION_INFORMATION   pConnectionInformation,
  [in]      IN PRXCE_CONNECTION_EVENT_HANDLER pHandler,
  [in]      IN PVOID                          pEventContext,
  [in, out] IN OUT PRXCE_CONNECTION           pConnection,
  [in, out] IN OUT PRXCE_VC                   pVc
);

Parameters

pLocalAddress

A pointer to the local RDBSS connection engine address.

[in] pConnectionInformation

A pointer to the connection information that specifies the remote address.

[in] pHandler

A pointer to the event handler for processing receive indications.

[in] pEventContext

A pointer to the context parameter to be passed back to the event handler and used for indications.

[in, out] pConnection

On input, this parameter contains a pointer to an uninitialized RDBSS connection. On output when this call is successful, the connection is properly initialized.

[in, out] pVc

On input, this parameter contains a pointer to an uninitialized RDBSS virtual circuit. On output when this call is successful, the virtual circuit is associated with the connection and the virtual circuit is properly initialized.

Return value

RxCeBuildConnection returns STATUS_SUCCESS on success or one of the following error codes on failure:

Return code	Description
STATUS_INSUFFICIENT_RESOURCES	The allocation of nonpaged pool memory needed by this routine failed.
STATUS_INVALID_PARAMETER	One of the parameters passed to this routine was invalid.

Remarks

RxCeBuildConnection should be called in the context of a system worker thread.

When RxCeBuildConnection is successful, the data members in the RXCE_CONNECTION structure pointed to by the pConnection parameter and the data members in the RXCE_VC structure pointed to by the pVc parameter will be properly initialized and the virtual circuit will be associated with the connection.

RXCE_CONNECTION_INFORMATION is a typedef for a TDI_CONNECTION_INFORMATION structure.

Requirements

Requirement	Value
Target Platform	Desktop
Header	rxce.h (include Rxce.h)
IRQL	<= APC_LEVEL