1
0
Fork 0
mirror of https://github.com/reactos/reactos.git synced 2025-06-20 07:36:05 +00:00
* Annotate batclass.h.

svn path=/trunk/; revision=58477
This commit is contained in:
Amine Khaldi 2013-03-12 21:16:25 +00:00
parent 6b643aa953
commit 6993ef3cbb

View file

@ -163,28 +163,40 @@ typedef struct _BATTERY_STATUS {
#define BATTERY_CLASS_MAJOR_VERSION 0x0001 #define BATTERY_CLASS_MAJOR_VERSION 0x0001
#define BATTERY_CLASS_MINOR_VERSION 0x0000 #define BATTERY_CLASS_MINOR_VERSION 0x0000
_Function_class_(BCLASS_QUERY_TAG_CALLBACK)
_IRQL_requires_same_
_IRQL_requires_max_(PASSIVE_LEVEL)
_Check_return_
typedef NTSTATUS typedef NTSTATUS
(NTAPI BCLASS_QUERY_TAG_CALLBACK)( (NTAPI BCLASS_QUERY_TAG_CALLBACK)(
IN PVOID Context, _In_ PVOID Context,
OUT PULONG BatteryTag); _Out_ PULONG BatteryTag);
typedef BCLASS_QUERY_TAG_CALLBACK *PBCLASS_QUERY_TAG_CALLBACK; typedef BCLASS_QUERY_TAG_CALLBACK *PBCLASS_QUERY_TAG_CALLBACK;
_Function_class_(BCLASS_QUERY_INFORMATION_CALLBACK)
_IRQL_requires_same_
_IRQL_requires_max_(PASSIVE_LEVEL)
_Check_return_
typedef NTSTATUS typedef NTSTATUS
(NTAPI BCLASS_QUERY_INFORMATION_CALLBACK)( (NTAPI BCLASS_QUERY_INFORMATION_CALLBACK)(
IN PVOID Context, _In_ PVOID Context,
IN ULONG BatteryTag, _In_ ULONG BatteryTag,
IN BATTERY_QUERY_INFORMATION_LEVEL Level, _In_ BATTERY_QUERY_INFORMATION_LEVEL Level,
IN LONG AtRate, _In_ LONG AtRate,
OUT PVOID Buffer, _Out_writes_bytes_to_(BufferLength, *ReturnedLength) PVOID Buffer,
IN ULONG BufferLength, _In_ ULONG BufferLength,
OUT PULONG ReturnedLength); _Out_ PULONG ReturnedLength);
typedef BCLASS_QUERY_INFORMATION_CALLBACK *PBCLASS_QUERY_INFORMATION_CALLBACK; typedef BCLASS_QUERY_INFORMATION_CALLBACK *PBCLASS_QUERY_INFORMATION_CALLBACK;
_Function_class_(BCLASS_QUERY_STATUS_CALLBACK)
_IRQL_requires_same_
_IRQL_requires_max_(PASSIVE_LEVEL)
_Check_return_
typedef NTSTATUS typedef NTSTATUS
(NTAPI BCLASS_QUERY_STATUS_CALLBACK)( (NTAPI BCLASS_QUERY_STATUS_CALLBACK)(
IN PVOID Context, _In_ PVOID Context,
IN ULONG BatteryTag, _In_ ULONG BatteryTag,
OUT PBATTERY_STATUS BatteryStatus); _Out_ PBATTERY_STATUS BatteryStatus);
typedef BCLASS_QUERY_STATUS_CALLBACK *PBCLASS_QUERY_STATUS_CALLBACK; typedef BCLASS_QUERY_STATUS_CALLBACK *PBCLASS_QUERY_STATUS_CALLBACK;
typedef struct _BATTERY_NOTIFY { typedef struct _BATTERY_NOTIFY {
@ -193,24 +205,36 @@ typedef struct _BATTERY_NOTIFY {
ULONG HighCapacity; ULONG HighCapacity;
} BATTERY_NOTIFY, *PBATTERY_NOTIFY; } BATTERY_NOTIFY, *PBATTERY_NOTIFY;
_Function_class_(BCLASS_SET_STATUS_NOTIFY_CALLBACK)
_IRQL_requires_same_
_IRQL_requires_max_(PASSIVE_LEVEL)
_Check_return_
typedef NTSTATUS typedef NTSTATUS
(NTAPI BCLASS_SET_STATUS_NOTIFY_CALLBACK)( (NTAPI BCLASS_SET_STATUS_NOTIFY_CALLBACK)(
IN PVOID Context, _In_ PVOID Context,
IN ULONG BatteryTag, _In_ ULONG BatteryTag,
IN PBATTERY_NOTIFY BatteryNotify); _In_ PBATTERY_NOTIFY BatteryNotify);
typedef BCLASS_SET_STATUS_NOTIFY_CALLBACK *PBCLASS_SET_STATUS_NOTIFY_CALLBACK; typedef BCLASS_SET_STATUS_NOTIFY_CALLBACK *PBCLASS_SET_STATUS_NOTIFY_CALLBACK;
_Function_class_(BCLASS_SET_INFORMATION_CALLBACK)
_IRQL_requires_same_
_IRQL_requires_max_(PASSIVE_LEVEL)
_Check_return_
typedef NTSTATUS typedef NTSTATUS
(NTAPI BCLASS_SET_INFORMATION_CALLBACK)( (NTAPI BCLASS_SET_INFORMATION_CALLBACK)(
IN PVOID Context, _In_ PVOID Context,
IN ULONG BatteryTag, _In_ ULONG BatteryTag,
IN BATTERY_SET_INFORMATION_LEVEL Level, _In_ BATTERY_SET_INFORMATION_LEVEL Level,
IN PVOID Buffer OPTIONAL); _In_opt_ PVOID Buffer);
typedef BCLASS_SET_INFORMATION_CALLBACK *PBCLASS_SET_INFORMATION_CALLBACK; typedef BCLASS_SET_INFORMATION_CALLBACK *PBCLASS_SET_INFORMATION_CALLBACK;
_Function_class_(BCLASS_DISABLE_STATUS_NOTIFY_CALLBACK)
_IRQL_requires_same_
_IRQL_requires_max_(PASSIVE_LEVEL)
_Check_return_
typedef NTSTATUS typedef NTSTATUS
(NTAPI BCLASS_DISABLE_STATUS_NOTIFY_CALLBACK)( (NTAPI BCLASS_DISABLE_STATUS_NOTIFY_CALLBACK)(
IN PVOID Context); _In_ PVOID Context);
typedef BCLASS_DISABLE_STATUS_NOTIFY_CALLBACK *PBCLASS_DISABLE_STATUS_NOTIFY_CALLBACK; typedef BCLASS_DISABLE_STATUS_NOTIFY_CALLBACK *PBCLASS_DISABLE_STATUS_NOTIFY_CALLBACK;
typedef PBCLASS_QUERY_TAG_CALLBACK BCLASS_QUERY_TAG; typedef PBCLASS_QUERY_TAG_CALLBACK BCLASS_QUERY_TAG;
@ -302,57 +326,67 @@ typedef struct _BATTERY_TAG_CHANGE {
#define BCLASSAPI DECLSPEC_IMPORT #define BCLASSAPI DECLSPEC_IMPORT
#endif #endif
_IRQL_requires_max_(PASSIVE_LEVEL)
_Check_return_
BCLASSAPI BCLASSAPI
NTSTATUS NTSTATUS
NTAPI NTAPI
BatteryClassInitializeDevice( BatteryClassInitializeDevice(
IN PBATTERY_MINIPORT_INFO MiniportInfo, _In_ PBATTERY_MINIPORT_INFO MiniportInfo,
IN PVOID *ClassData); _Out_ PVOID *ClassData);
_IRQL_requires_max_(PASSIVE_LEVEL)
_Check_return_
BCLASSAPI BCLASSAPI
NTSTATUS NTSTATUS
NTAPI NTAPI
BatteryClassIoctl( BatteryClassIoctl(
IN PVOID ClassData, _In_ PVOID ClassData,
IN OUT PIRP Irp); _Inout_ PIRP Irp);
_IRQL_requires_max_(DISPATCH_LEVEL)
BCLASSAPI BCLASSAPI
NTSTATUS NTSTATUS
NTAPI NTAPI
BatteryClassStatusNotify( BatteryClassStatusNotify(
IN PVOID ClassData); _In_ PVOID ClassData);
#if (NTDDI_VERSION >= NTDDI_WINXP) #if (NTDDI_VERSION >= NTDDI_WINXP)
_IRQL_requires_max_(PASSIVE_LEVEL)
_Check_return_
BCLASSAPI BCLASSAPI
NTSTATUS NTSTATUS
NTAPI NTAPI
BatteryClassQueryWmiDataBlock( BatteryClassQueryWmiDataBlock(
IN PVOID ClassData, _In_ PVOID ClassData,
IN OUT PDEVICE_OBJECT DeviceObject, _Inout_ PDEVICE_OBJECT DeviceObject,
IN OUT PIRP Irp, _Inout_ PIRP Irp,
IN ULONG GuidIndex, _In_ ULONG GuidIndex,
OUT PULONG InstanceLengthArray, _Out_writes_(1) PULONG InstanceLengthArray,
IN ULONG OutBufferSize, _In_ ULONG OutBufferSize,
OUT PUCHAR Buffer OPTIONAL); _Out_writes_bytes_opt_(OutBufferSize) PUCHAR Buffer);
_IRQL_requires_max_(PASSIVE_LEVEL)
_Check_return_
BCLASSAPI BCLASSAPI
NTSTATUS NTSTATUS
NTAPI NTAPI
BatteryClassSystemControl( BatteryClassSystemControl(
IN PVOID ClassData, _In_ PVOID ClassData,
IN PVOID WmiLibContext, /* PWMILIB_CONTEXT */ _In_ PVOID WmiLibContext, /* PWMILIB_CONTEXT */
IN PDEVICE_OBJECT DeviceObject, _In_ PDEVICE_OBJECT DeviceObject,
IN OUT PIRP Irp, _Inout_ PIRP Irp,
OUT PVOID Disposition); /* PSYSCTL_IRP_DISPOSITION */ _Out_ PVOID Disposition); /* PSYSCTL_IRP_DISPOSITION */
#endif /* (NTDDI_VERSION >= NTDDI_WINXP) */ #endif /* (NTDDI_VERSION >= NTDDI_WINXP) */
_IRQL_requires_max_(PASSIVE_LEVEL)
BCLASSAPI BCLASSAPI
NTSTATUS NTSTATUS
NTAPI NTAPI
BatteryClassUnload( BatteryClassUnload(
IN PVOID ClassData); _In_ PVOID ClassData);
#endif /* _WINDOWS_H */ #endif /* _WINDOWS_H */