GetFrame function

The GetFrame function returns a handle to a given frame within a capture.

Syntax

HFRAME WINAPI GetFrame(
  _In_ HCAPTURE hCapture,
  _In_ DWORD    FrameNumber
);

Parameters

hCapture [in]

Handle to a capture. To obtain the capture handle, call the GetFrameCaptureHandle function.

FrameNumber [in]

Number (zero-based) of the frame. The number of the first frame in a capture is zero.

Return value

If the function is successful, the return value is a handle to the frame.

If the function is unsuccessful (that is, if hCapture is invalid, or the frame number is out of range), the return value is NULL.

Remarks

Use the GetFrame function to obtain the frame handle needed when locating instances of a property. The functions used to locate property instances are FindPropertyInstance which locates the first instance, and FindPropertyInstanceRestart which locates the next instance.

Experts and parsers can call the GetFrame function.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Netmon.h
Library	Nmapi.lib
DLL	Nmapi.dll

See also

FindPropertyInstance

FindPropertyInstanceRestart