sbWindowsFormatter Class Reference

#include <sbWindowsFormatter.h>

Inheritance diagram for sbWindowsFormatter:

Collaboration diagram for sbWindowsFormatter:

Public Member Functions
	STDMETHOD_ (ULONG, AddRef)()
	STDMETHOD_ (ULONG, Release)()
STDMETHOD()	QueryInterface (REFIID aIID, void **aInterface)
STDMETHOD()	Format (BSTR aVolumeName, unsigned long aType, BSTR aLabel, DWORD aUnitAllocationSize, long aForce, long aQuickFormat, long aEnableCompression)
virtual	~sbWindowsFormatter ()

Static Public Member Functions
static HRESULT	New (sbWindowsFormatter **aWindowsFormatter)

Detailed Description

This class implements an sbIWindowsFormatter interface for formatting volumes.

Definition at line 70 of file sbWindowsFormatter.h.

Constructor & Destructor Documentation

sbWindowsFormatter::~sbWindowsFormatter ( )

virtual

Destroy an instance of a Songbird Windows formatter object.

Definition at line 245 of file sbWindowsFormatter.cpp.

Member Function Documentation

STDMETHODIMP sbWindowsFormatter::Format	(	BSTR	aVolumeName,
		unsigned long	aType,
		BSTR	aLabel,
		DWORD	aUnitAllocationSize,
		long	aForce,
		long	aQuickFormat,
		long	aEnableCompression
	)

Format the volume with the volume name specified by aVolumeName. The volume name is the volume GUID path without the trainling slash. The formatted file system type is specified by aType. The volume label is specified by aLabel. The file system unit allocation size is specified by aUnitAllocationSize; a value of 0 specifies that a default value should be used. If aForce is true, the file system is formatted even if the volume is in use. If aQuickFormat is true, a quick format is performed. If aEnableCompression is true, compression is enabled for NTFS file systems.

Parameters

aVolumeName	Name of volume to format.
aType	Type of file system to use.
aLabel	Volume label.
aUnitAllocationSize	File system unit allocation size.
aForce	If true, force format even if volume is in use.
aQuickFormat	If true, perform a quick format.
aEnableCompression	If true, enable compression for NTFS file systems.

Definition at line 155 of file sbWindowsFormatter.cpp.

HRESULT sbWindowsFormatter::New ( sbWindowsFormatter **  aWindowsFormatter )

static

Create a new Songbird Windows formatter object and return it in aWindowsFormatter.

Parameters

aWindowsFormatter

Returned created Windows formatter object.

Definition at line 214 of file sbWindowsFormatter.cpp.

Here is the caller graph for this function:

STDMETHODIMP sbWindowsFormatter::QueryInterface	(	REFIID	aIID,
		void **	aInterface
	)

Return in aInterface an implementation of this object with the interface specified by aIID. If this object does not support the specified interface, return E_NOINTERFACE.

Parameters

aIID	Requested interface.
aInterface	Returned interface object.

Returns

E_NOINTERFACE Requested interface is not supported.

Definition at line 102 of file sbWindowsFormatter.cpp.

Here is the caller graph for this function:

sbWindowsFormatter::STDMETHOD_	(	ULONG	,
		AddRef
	)

sbWindowsFormatter::STDMETHOD_	(	ULONG	,
		Release
	)

---

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

• /home/martin/dev/nightingale-hacking/components/moz/system/windows/formatter/src/sbWindowsFormatter.h
• /home/martin/dev/nightingale-hacking/components/moz/system/windows/formatter/src/sbWindowsFormatter.cpp