IRTC::Connect method

The Connect method connects the NPP to the network by using a specified NIC and provides configuration information for the connection.

Syntax

HRESULT STDMETHODCALLTYPE Connect(
  [in]  HBLOB  hInputBlob,
  [in]  LPVOID StatusCallbackProc,
  [in]  LPVOID FramesCallbackProc,
  [in]  LPVOID UserContext,
  [out] HBLOB  hErrorBlob
);

Parameters

hInputBlob [in]

Handle to the BLOB that specifies the NIC that you are connecting to and the configuration information for that connection.

StatusCallbackProc [in]

Address of the user's status callback function, which receives status updates such as triggers. This parameter can be set to NULL.

FramesCallbackProc [in]

Address of the user's frame callback function, which is used to receive status updates such as triggers. This parameter can be set to NULL.

UserContext [in]

Value passed when the user's status and frame callback function is called. If both callback functions are specified, they must use the same user-context value. The value of this parameter is typically either HWND or a 'this' pointer.

hErrorBlob [out]

Handle to an error BLOB that contains additional error information. See Remarks at the bottom of this topic for information about what is in the error BLOB.

Return value

If this method is successful, the return value is NMERR_SUCCESS.

If the method is unsuccessful, the return value is one of the following error codes (which include those errors returned by the internal IRTC::Configure call):

Remarks

When the Connect method is called, the NPP automatically calls the IRTC::Configure method by using the BLOB provided by hInputBlob. Note that any error codes returned by the call to IRTC::Configure are passed back and returned by the IRTC::Connect call.

This method must be called before you can start capturing frames. Note that when you connect to the network using this method, you must continue to use the IRTC interface to capture frames.

When calling this function, you must specify a status or frame callback function, even if it only acts as a placeholder.

The input BLOB specified by hInputBlob can be obtained by calling the GetNPPBlobFromUI, GetNPPBlobTable, and SelectNPPBlobFromTable methods.

The error BLOB returned in hErrorBlob contains error information that the developer or the application can use for troubleshooting. The error BLOB returned by hErrorBlob contains entries that Network Monitor could not understand or find in the input BLOB specified in hInputBlob. For example, if NMERR_BLOB_ENTRY_DOES_NOT_EXIST is returned, the entry Network Monitor could not find is included in the returned error BLOB.

Requirements

See also

IRTC

IRTC::Configure

IRTC::Disconnect

IRTC::Start