GetProtocolFromTable Function

Article
11/09/2009

The GetProtocolFromTable function returns a handle to a protocol—based on a given handoff table and value.

Syntax

HPROTOCOL WINAPI GetProtocolFromTable(
  __in   LPHANDOFFTABLE hTable,
  __in   DWORD ItemToFind,
  __out  PDWORD_PTR lpInstData
);

Parameters

hTable [in]
Handle to a handoff table.
ItemToFind [in]
Value used to locate the protocol in a handoff table. The value must be available in the protocol data.
lpInstData [out]
If available in the handoff table, instance data for the next protocol. Instance data cannot be longer than a DWORD_PTR in length.

Return Value

If the function is successful, the return value is a protocol handle.

If the function is unsuccessful, the return value is NULL.

Remarks

When implementing the RecognizeFrame export function, the GetProtocolFromTable function is used to obtain a handle to the next protocol. The GetProtocolFromTable function is called to retrieve a handle from the next protocol—if the protocol identifies which protocol follows.

Instance data

Instance data can be any data that is less than or equal to a DWORD_PTR in length, or a pointer to data, such as raw frame data, that does not need to be allocated by or freed by the parser.

Requirements

Minimum supported client	Windows 2000 Professional
Minimum supported server	Windows 2000 Server
Header	Netmon.h
Library	Nmapi.lib
DLL	Nmapi.dll

Share via