#include "fxsupportpch.hpp"

Include dependency graph for fxcollectionapi.cpp:

Functions
_Must_inspect_result_	__drv_maxIRQL (DISPATCH_LEVEL) NTSTATUS NTAPI WDFEXPORT(WdfCollectionCreate)(__in PWDF_DRIVER_GLOBALS DriverGlobals

	if (NT_SUCCESS(FxValidateObjectAttributesForParentHandle(pFxDriverGlobals, CollectionAttributes)))

	FxPointerNotNull (pFxDriverGlobals, Collection)

	if (!NT_SUCCESS(status))

	if (pCollection !=NULL)

	FxObjectHandleGetPtr (GetFxDriverGlobals(DriverGlobals), Collection, FX_TYPE_COLLECTION,(PVOID *)&pCollection)

pCollection	Unlock (irql)

	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), Collection, FX_TYPE_COLLECTION,(PVOID *) &pCollection, &pFxDriverGlobals)

	FxObjectHandleGetPtr (pFxDriverGlobals, Object, FX_TYPE_OBJECT,(PVOID *) &pObject)

	if (pEntry !=NULL)

	if (pObject !=NULL)

	FxObjectHandleGetPtr (pFxDriverGlobals, Item, FX_TYPE_OBJECT,(PVOID *) &pObject)

	FxObjectHandleGetPtr (GetFxDriverGlobals(DriverGlobals), Collection, FX_TYPE_COLLECTION,(PVOID *) &pCollection)

	if (pObject==NULL)

return pObject	GetObjectHandle ()

Variables
_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES	CollectionAttributes

_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __out WDFCOLLECTION *	Collection

PFX_DRIVER_GLOBALS	pFxDriverGlobals = GetFxDriverGlobals(DriverGlobals)

NTSTATUS	status = FxValidateObjectAttributes(pFxDriverGlobals, CollectionAttributes)

FxCollection *	pCollection

WDFCOLLECTION	hCol

	else

KIRQL	irql

ULONG	count = pCollection->Count()

_Must_inspect_result_ __in WDFCOLLECTION __in WDFOBJECT	Object

FxObject *	pObject = pCollection->GetItem(Index)

__in WDFCOLLECTION __in ULONG	Index

FxCollectionEntry *	pEntry = pCollection->FindEntry(Index)

__in WDFCOLLECTION __in WDFOBJECT	Item

Function Documentation

◆ __drv_maxIRQL()

_Must_inspect_result_ __drv_maxIRQL ( DISPATCH_LEVEL )

◆ FxObjectHandleGetPtr() [1/4]

FxObjectHandleGetPtr	(	GetFxDriverGlobals(DriverGlobals)	,
		Collection	,
		FX_TYPE_COLLECTION	,
		(PVOID *) &	pCollection
	)

◆ FxObjectHandleGetPtr() [2/4]

FxObjectHandleGetPtr	(	GetFxDriverGlobals(DriverGlobals)	,
		Collection	,
		FX_TYPE_COLLECTION	,
		(PVOID *)&	pCollection
	)

◆ FxObjectHandleGetPtr() [3/4]

FxObjectHandleGetPtr	(	pFxDriverGlobals	,
		Item	,
		FX_TYPE_OBJECT	,
		(PVOID *) &	pObject
	)

◆ FxObjectHandleGetPtr() [4/4]

FxObjectHandleGetPtr	(	pFxDriverGlobals	,
		Object	,
		FX_TYPE_OBJECT	,
		(PVOID *) &	pObject
	)

◆ FxObjectHandleGetPtrAndGlobals()

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		Collection	,
		FX_TYPE_COLLECTION	,
		(PVOID *) &	pCollection,
		&	pFxDriverGlobals
	)

Referenced by if().

◆ FxPointerNotNull()

FxPointerNotNull	(	pFxDriverGlobals	,
		Collection
	)

◆ GetObjectHandle()

return pObject GetObjectHandle ( )

Referenced by __drv_requiresIRQL(), _Releases_lock_(), FxResourceCollection::AddAt(), FxCommonBuffer::AllocateCommonBuffer(), FxObject::CallCleanupCallbacks(), FxDmaTransactionBase::CancelResourceAllocation(), FxIoQueue::CanThreadDispatchEventsLocked(), FxIoTargetRemote::ClearTargetPointers(), FxIoTargetRemote::Close(), FxIoTarget::CompleteCanceledRequest(), FxRequest::CompleteInternal(), FxIoQueue::ConfigureConstraints(), FxIoQueue::DispatchRequestToDriver(), FxDmaTransactionBase::Dispose(), FxDpc::DpcHandler(), FxIoTarget::DrainPendedRequestsLocked(), FxDmaTransactionBase::Execute(), FxRequest::GetDeviceControlOutputMemoryObject(), FxDmaTransactionBase::GetHandle(), FxChildList::GetHandle(), FxDeviceBase::GetHandle(), FxDriver::GetHandle(), FxFileObject::GetHandle(), FxInterrupt::GetHandle(), FxIoQueue::GetHandle(), FxIoTarget::GetHandle(), FxIoTargetRemote::GetHandle(), FxMemoryObject::GetHandle(), FxRequestBase::GetHandle(), FxCmResList::GetHandle(), FxIoResReqList::GetHandle(), FxIoResList::GetHandle(), FxTimer::GetHandle(), FxUsbInterface::GetHandle(), FxUsbPipe::GetHandle(), FxUserObject::GetHandle(), FxWmiInstance::GetHandle(), FxWmiProvider::GetHandle(), FxWorkItem::GetHandle(), FxDmaEnabler::GetHandle(), FxRequest::GetMemoryObject(), FxIoQueue::GetRequest(), FxIoTargetRemote::GetTargetDeviceRelations(), FxRequestBase::GetTraceObjectHandle(), FxDmaTransactionBase::GetTransferInfo(), FxIoTarget::GotoPurgeState(), FxIoTarget::GotoRemoveState(), FxIoTarget::GotoStartState(), FxIoTarget::GotoStopState(), FxIoTarget::HandleFailedResubmit(), if(), FxIoTarget::Init(), FxDmaTransactionBase::Initialize(), FxIoQueue::Initialize(), FxIoTargetRemote::Open(), FxIoTargetRemote::OpenTargetHandle(), FxIoQueue::PostRequestCompletedCallback(), FxIoQueue::PreRequestCompletedCallback(), FxIoTarget::PrintDisposeMessage(), FxRequest::ProbeAndLockForRead(), FxRequest::ProbeAndLockForWrite(), FxChildList::ProcessModificationsLocked(), FxIoQueue::QueueDrainSynchronously(), FxIoQueue::QueueIdle(), FxIoQueue::QueueIdleSynchronously(), FxIoQueue::QueuePurge(), FxIoQueue::QueuePurgeSynchronously(), FxIoQueue::QueueRequest(), FxIoQueue::QueueRequestFromForward(), FxIoQueue::ReadyNotify(), FxDmaPacketTransaction::ReleaseAdapter(), FxDmaTransactionBase::ReleaseForReuse(), FxResourceCollection::RemoveAndDelete(), FxIoTarget::RemoveCompletedRequestLocked(), FxIoQueue::RequestCompletedCallback(), FxIoTarget::RequestCompletionRoutine(), FxDmaPacketTransaction::ReserveAdapter(), FxUsbDevice::SelectConfigMulti(), FxIoTargetSelf::Send(), FxIoQueue::SetState(), FxIoQueue::StartPowerTransitionOff(), FxIoQueue::StopProcessingForPower(), FxDmaSystemTransaction::StopTransfer(), FxIoTarget::SubmitLocked(), FxIoTarget::SubmitSync(), FxIoTarget::TimerCallback(), and FxIoTarget::WaitForDisposeEvent().

◆ if() [1/6]

if ( ! NT_SUCCESSstatus )

Definition at line 76 of file fxcollectionapi.cpp.

                             {
        return status;
    }

◆ if() [2/6]

if ( NT_SUCCESS(FxValidateObjectAttributesForParentHandle( pFxDriverGlobals, CollectionAttributes)) )

Definition at line 60 of file fxcollectionapi.cpp.

                                                                  {
        FxObject* pParent;
 
        FxObjectHandleGetPtrAndGlobals(pFxDriverGlobals,
                                       CollectionAttributes->ParentObject,
                                       FX_TYPE_OBJECT,
                                       (PVOID*)&pParent,
                                       &pFxDriverGlobals);
    }

◆ if() [3/6]

if ( pCollection ! = NULL )

Definition at line 83 of file fxcollectionapi.cpp.

                             {
        status = pCollection->Commit(CollectionAttributes, (WDFOBJECT*)&hCol);
 
        if (NT_SUCCESS(status)) {
            *Collection = hCol;
        }
        else {
            DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGERROR,
                                "Could not create collection object: %!STATUS!",
                                status);
 
            pCollection->DeleteFromFailedCreate();
        }
    }

◆ if() [4/6]

if ( pEntry ! = NULL )

Definition at line 205 of file fxcollectionapi.cpp.

                        {
        pObject = pEntry->m_Object;
        pCollection->CleanupEntry(pEntry);
        status = STATUS_SUCCESS;
    }

◆ if() [5/6]

if ( pObject ! = NULL )

Definition at line 217 of file fxcollectionapi.cpp.

                         {
        pCollection->CleanupEntryObject(pObject);
    }

◆ if() [6/6]

if ( pObject = = NULL )

Definition at line 316 of file fxcollectionapi.cpp.

                         {
        return NULL;
    }

◆ Unlock()

pCollection Unlock ( irql )

Variable Documentation

◆ Collection

__in WDFCOLLECTION Collection

Initial value:

{

DDI_ENTRY()

DDI_ENTRY

#define DDI_ENTRY()

Definition: fxglobalskm.h:56

Definition at line 45 of file fxcollectionapi.cpp.

◆ CollectionAttributes

_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES CollectionAttributes

Definition at line 43 of file fxcollectionapi.cpp.

Referenced by if().

◆ count

return count = pCollection->Count()

Definition at line 121 of file fxcollectionapi.cpp.

◆ else

else

Initial value:

{
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGERROR,
                            "Could not create collection object: "
                            "STATUS_INSUFFICIENT_RESOURCES" )

Definition at line 97 of file fxcollectionapi.cpp.