#include <fxstring.hpp>

Inheritance diagram for FxString:

Collaboration diagram for FxString:

[legend]

Public Member Functions
	FxString (__in PFX_DRIVER_GLOBALS FxDriverGlobals)

	~FxString ()

VOID __inline	ReleaseString (__out PUNICODE_STRING ReleaseTo)

__inline	operator PUNICODE_STRING ()

PUNICODE_STRING __inline	GetUnicodeString (VOID)

_Must_inspect_result_ NTSTATUS	Assign (__in PCWSTR SourceString)

_Must_inspect_result_ NTSTATUS	Assign (__in const UNICODE_STRING *UnicodeString)

__inline USHORT	Length (VOID)

__inline USHORT	ByteLength (__in BOOLEAN IncludeNull)

__inline USHORT	CharacterLength (VOID)

__inline USHORT	MaximumLength (VOID)

__inline USHORT	MaximumByteLength (VOID)

__inline USHORT	MaximumCharacterLength (VOID)

__inline PWCHAR	Buffer (VOID)

Public Member Functions inherited from FxObject
PVOID	GetCOMWrapper ()

void	SetCOMWrapper (__drv_aliasesMem PVOID Wrapper)

	FxObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

virtual	~FxObject (VOID)

PVOID __inline	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObjectType Type)

PVOID __inline	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __in USHORT ExtraSize=0)

VOID	operator delete (__in PVOID Memory)

VOID	SetNoContextHeader (VOID)

PVOID __inline	GetObjectHandle (VOID)

__inline FxContextHeader *	GetContextHeader (VOID)

__inline PFX_DRIVER_GLOBALS	GetDriverGlobals (VOID)

WDFTYPE	GetType (VOID)

USHORT	GetObjectSize (VOID)

LONG	GetRefCnt (VOID)

FxTagTracker *	GetTagTracker (VOID)

CfxDevice *	GetDevice (VOID)

CfxDeviceBase *	GetDeviceBase (VOID)

VOID	SetDeviceBase (__in CfxDeviceBase *DeviceBase)

__inline VOID	CallCleanup (VOID)

ULONG __inline	AddRef (__in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual ULONG	Release (__in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual ULONG	AddRefOverride (__in WDFOBJECT_OFFSET Offset, __in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual ULONG	ReleaseOverride (__in WDFOBJECT_OFFSET Offset, __in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual _Must_inspect_result_ NTSTATUS	QueryInterface (__in FxQueryInterfaceParams *Params)

VOID	MarkTraceState (VOID)

BOOLEAN __inline	IsTraceState (VOID)

VOID __inline	TraceDroppedEvent (__in FxObjectDroppedEvent Event)

VOID	MarkPassiveDispose (__in FxObjectLockState State=ObjectLock)

VOID	MarkPassiveCallbacks (__in FxObjectLockState State=ObjectLock)

VOID	MarkForceDisposeThread (__in FxObjectLockState State=ObjectLock)

BOOLEAN	IsPassiveCallbacks (__in BOOLEAN AcquireLock=TRUE)

BOOLEAN	IsPassiveDispose (__in BOOLEAN AcquireLock=TRUE)

BOOLEAN	IsForceDisposeThread (__in BOOLEAN AcquireLock=TRUE)

VOID	MarkCommitted (VOID)

BOOLEAN	IsCommitted (VOID)

VOID	MarkDisposeOverride (__in FxObjectLockState State=ObjectLock)

VOID	MarkNoDeleteDDI (__in FxObjectLockState State=ObjectLock)

BOOLEAN	IsNoDeleteDDI (VOID)

_Must_inspect_result_ NTSTATUS	Commit (__in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __out_opt WDFOBJECT ObjectHandle, __in_opt FxObject Parent=NULL, __in BOOLEAN AssignDriverAsDefaultParent=TRUE)

VOID	DeleteFromFailedCreate (VOID)

VOID	ClearEvtCallbacks (VOID)

BOOLEAN	EarlyDispose (VOID)

virtual VOID	DeleteObject (VOID)

virtual BOOLEAN	Dispose (VOID)

_Must_inspect_result_ NTSTATUS	AssignParentObject (__in FxObject *ParentObject)

_Must_inspect_result_ NTSTATUS	AddContext (__in FxContextHeader Header, __in PVOID Context, __in PWDF_OBJECT_ATTRIBUTES Attributes)

_Must_inspect_result_ NTSTATUS	RemoveParentAssignment (VOID)

_Must_inspect_result_ FxObject *	GetParentObjectReferenced (__in PVOID Tag)

BOOLEAN	IsDisposed (VOID)

Public Attributes
UNICODE_STRING	m_UnicodeString

Additional Inherited Members
Static Public Member Functions inherited from FxObject
static FxObject *	_FromDisposeEntry (__in PSINGLE_LIST_ENTRY Entry)

static FxObject *	_GetObjectFromHandle (__in WDFOBJECT Handle, __inout PWDFOBJECT_OFFSET ObjectOffset)

static PVOID __inline	_ToHandle (__in FxObject *Object)

static VOID __inline	_ReferenceActual (__in WDFOBJECT Object, __in_opt PVOID Tag, __in LONG Line, __in PSTR File)

static VOID __inline	_DereferenceActual (__in WDFOBJECT Object, __in_opt PVOID Tag, __in LONG Line, __in PSTR File)

static PVOID	_GetDebugBase (__in FxObject *Object)

static PFX_POOL_HEADER	_CleanupPointer (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObject *Object)

static _Must_inspect_result_ NTSTATUS	_GetEffectiveLock (__in FxObject Object, __in_opt IFxHasCallbacks Callbacks, __in BOOLEAN AutomaticLocking, __in BOOLEAN PassiveCallbacks, __out FxCallbackLock CallbackLock, __out_opt FxObject CallbackLockObject)

static _Must_inspect_result_ NTSTATUS	_ObjectQuery (_In_ FxObject Object, _In_ CONST GUID Guid, _In_ ULONG QueryBufferLength, _Out_writes_bytes_(QueryBufferLength) PVOID QueryBuffer)

Protected Member Functions inherited from FxObject
	FxObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObjectType ObjectType)

FxObjectDebugExtension *	GetDebugExtension (VOID)

BOOLEAN	IsDebug (VOID)

VOID	AllocateTagTracker (__in WDFTYPE Type)

virtual VOID	SelfDestruct (VOID)

PVOID __inline	GetObjectHandleUnchecked (VOID)

VOID __inline	DestroyChildren (VOID)

VOID	DeleteEarlyDisposedObject (VOID)

Static Protected Member Functions inherited from FxObject
static PVOID	_GetBase (__in FxObject *Object)

Protected Attributes inherited from FxObject
union {
CfxDeviceBase * m_DeviceBase

CfxDevice * m_Device

};

Detailed Description

Definition at line 30 of file fxstring.hpp.

Constructor & Destructor Documentation

◆ FxString()

FxString::FxString ( __in PFX_DRIVER_GLOBALS FxDriverGlobals )

Definition at line 28 of file fxstring.cpp.

      :
    FxObject(FX_TYPE_STRING, sizeof(FxString), FxDriverGlobals)
{
    RtlInitUnicodeString(&m_UnicodeString, NULL);
    MarkPassiveDispose(ObjectDoNotLock);
}

◆ ~FxString()

FxString::~FxString ( )

Definition at line 37 of file fxstring.cpp.

{
    if (m_UnicodeString.Buffer) {
        FxPoolFree(m_UnicodeString.Buffer);
    }
}

Member Function Documentation

◆ Assign() [1/2]

_Must_inspect_result_ NTSTATUS FxString::Assign ( __in const UNICODE_STRING * UnicodeString )

Definition at line 46 of file fxstring.cpp.

{
    return FxDuplicateUnicodeString(GetDriverGlobals(),
                                    UnicodeString,
                                    &m_UnicodeString);
}

◆ Assign() [2/2]

_Must_inspect_result_ NTSTATUS FxString::Assign ( __in PCWSTR SourceString )

Definition at line 57 of file fxstring.cpp.

{
    UNICODE_STRING string;
 
    RtlInitUnicodeString(&string, SourceString);
 
    return Assign(&string);
}

Referenced by WDFDEVICE_INIT::_AllocateControlDeviceInit(), Assign(), FxDriver::GetRegistryPath(), and if().

◆ Buffer()

__inline PWCHAR FxString::Buffer ( VOID )

inline

Definition at line 144 of file fxstring.hpp.

    {
        return m_UnicodeString.Buffer;
    }

Referenced by FxCopyMultiSz(), and IntUnicodeStringToBuffer().

◆ ByteLength()

__inline USHORT FxString::ByteLength ( __in BOOLEAN IncludeNull )

inline

Definition at line 94 of file fxstring.hpp.

    {
        if (IncludeNull) {
            return m_UnicodeString.Length + sizeof(UNICODE_NULL);
        }
        else {
            return m_UnicodeString.Length;
        }
    }

Referenced by FxCalculateTotalStringSize(), and FxCopyMultiSz().

◆ CharacterLength()

__inline USHORT FxString::CharacterLength ( VOID )

inline

Definition at line 108 of file fxstring.hpp.

    {
        return m_UnicodeString.Length / sizeof(WCHAR);
    }

◆ GetUnicodeString()

PUNICODE_STRING __inline FxString::GetUnicodeString ( VOID )

inline

Definition at line 64 of file fxstring.hpp.

    {
        return &m_UnicodeString;
    }

◆ Length()

__inline USHORT FxString::Length ( VOID )

inline

Definition at line 85 of file fxstring.hpp.

    {
        return m_UnicodeString.Length;
    }

Referenced by IntUnicodeStringToBuffer().

◆ MaximumByteLength()

__inline USHORT FxString::MaximumByteLength ( VOID )

inline

Definition at line 126 of file fxstring.hpp.

    {
        return m_UnicodeString.MaximumLength;
    }

◆ MaximumCharacterLength()

__inline USHORT FxString::MaximumCharacterLength ( VOID )

inline

Definition at line 135 of file fxstring.hpp.

    {
        return m_UnicodeString.MaximumLength / sizeof(WCHAR);
    }

◆ MaximumLength()

__inline USHORT FxString::MaximumLength ( VOID )

inline

Definition at line 117 of file fxstring.hpp.

    {
        return m_UnicodeString.MaximumLength;
    }

◆ operator PUNICODE_STRING()

__inline FxString::operator PUNICODE_STRING ( )

inline

Definition at line 56 of file fxstring.hpp.

    {
        return &m_UnicodeString;
    }

◆ ReleaseString()

VOID __inline FxString::ReleaseString ( __out PUNICODE_STRING ReleaseTo )

inline

Definition at line 47 of file fxstring.hpp.

    {
        RtlCopyMemory(ReleaseTo, &m_UnicodeString, sizeof(UNICODE_STRING));
        RtlZeroMemory(&m_UnicodeString, sizeof(m_UnicodeString));
    }

Referenced by FxDevice::_Create().

Member Data Documentation

◆ m_UnicodeString

UNICODE_STRING FxString::m_UnicodeString

Definition at line 36 of file fxstring.hpp.

Referenced by Assign(), Buffer(), ByteLength(), CharacterLength(), FxString(), GetUnicodeString(), Length(), MaximumByteLength(), MaximumCharacterLength(), MaximumLength(), operator PUNICODE_STRING(), ReleaseString(), and ~FxString().

The documentation for this class was generated from the following files:

sdk/lib/drivers/wdf/shared/inc/private/common/fxstring.hpp
sdk/lib/drivers/wdf/shared/support/fxstring.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxString()

◆ ~FxString()

Member Function Documentation

◆ Assign() [1/2]

◆ Assign() [2/2]

◆ Buffer()

◆ ByteLength()

◆ CharacterLength()

◆ GetUnicodeString()

◆ Length()

◆ MaximumByteLength()

◆ MaximumCharacterLength()

◆ MaximumLength()

◆ operator PUNICODE_STRING()

◆ ReleaseString()

Member Data Documentation

◆ m_UnicodeString