Skip to content

Latest commit

 

History

History
100 lines (73 loc) · 3.16 KB

nc-ucxcontroller-evt_ucx_controller_get_current_framenumber.md

File metadata and controls

100 lines (73 loc) · 3.16 KB
Raw
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NC:ucxcontroller.EVT_UCX_CONTROLLER_GET_CURRENT_FRAMENUMBER
EVT_UCX_CONTROLLER_GET_CURRENT_FRAMENUMBER (ucxcontroller.h)
The client driver's implementation that UCX calls to retrieve the current 32-bit frame number.
buses\evt_ucx_controller_get_current_framenumber.htm
usbref
05/07/2018
EVT_UCX_CONTROLLER_GET_CURRENT_FRAMENUMBER callback function
EVT_UCX_CONTROLLER_GET_CURRENT_FRAMENUMBER, EVT_UCX_CONTROLLER_GET_CURRENT_FRAMENUMBER callback, EvtUcxControllerGetCurrentFrameNumber, EvtUcxControllerGetCurrentFrameNumber callback function [Buses], PEVT_UCX_CONTROLLER_GET_CURRENT_FRAMENUMBER, PEVT_UCX_CONTROLLER_GET_CURRENT_FRAMENUMBER callback function pointer [Buses], buses.evt_ucx_controller_get_current_framenumber, ucxcontroller/EvtUcxControllerGetCurrentFrameNumber
ucxcontroller.h
Ucxclass.h
Windows
1.0
2.0
PASSIVE_LEVEL
Windows
EVT_UCX_CONTROLLER_GET_CURRENT_FRAMENUMBER
ucxcontroller/EVT_UCX_CONTROLLER_GET_CURRENT_FRAMENUMBER
APIRef
kbSyntax
UserDefined
Ucxcontroller.h
EVT_UCX_CONTROLLER_GET_CURRENT_FRAMENUMBER

EVT_UCX_CONTROLLER_GET_CURRENT_FRAMENUMBER callback function

-description

The client driver's implementation that UCX calls to retrieve the current 32-bit frame number.

-parameters

-param UcxController [in]

A handle to the UCX controller that the client driver received in a previous call to the UcxControllerCreate method.

-param FrameNumber [out]

A pointer to the current 32-bit frame number.

-returns

If the operation is successful, the callback function must return STATUS_SUCCESS, or another status value for which NT_SUCCESS(status) equals TRUE. Otherwise it must return a status value for which NT_SUCCESS(status) equals FALSE.

-remarks

The UCX client driver registers its EVT_UCX_CONTROLLER_GET_CURRENT_FRAMENUMBER implementation with the USB host controller extension (UCX) by calling the UcxControllerCreate method.

Examples

NTSTATUS
Controller_EvtControllerGetCurrentFrameNumber(
    UCXCONTROLLER   UcxController,
    PULONG          FrameNumber
)

{
    UNREFERENCED_PARAMETER(UcxController);

    //
    // TODO: Return the current 32-bit frame number.  Do not access the
    // controller registers if the controller is not in D0.
    //

    *FrameNumber = 0xFFFFFFFF;

    DbgTrace(TL_INFO, Controller, "Controller_EvtControllerGetCurrentFrameNumber");

    return STATUS_SUCCESS;
}

-see-also

UcxControllerCreate