Class: TRequestVolumeDialogState

Declaration: CommonDialogs.h

Taxonomy Categories:

Member Functions:

Verify
TRequestVolumeDialogState
~TRequestVolumeDialogState
operator>>=
operator<<=

Interface Category:

API.

Inherits From:

TRequestFileSystemEntityDialogState

Inherited By:

None.

Purpose:

TRequestVolumeDialogState represents the state of a volume request dialog.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive from TRequestVolumeDialogState and override Accept/Cancel/Verify to create customized dialog behavior.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TRequestVolumeDialogState::Verify

virtual bool Verify (TPathName & pathName, TFileSystemEntity & entity, TText & errorMessage)

Interface Category:

API.

Purpose:

Verifies that the specified pathname represents a volume. If false is returned, errorMessage is filled in with a description of the error.

Calling Context:

Called by HandleAcceptButton.

Parameters:

TPathName & pathName -The name of the volume.
TFileSystemEntity & entity -Filled in with the entity of pathname.
TText & errorMessage -Filled in with an error message if false is returned.

Return Value:

Returns true if the specified pathname represents a volume.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRequestVolumeDialogState::TRequestVolumeDialogState

TRequestVolumeDialogState ()
TRequestVolumeDialogState (const TRequestVolumeDialogState & source)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called to create a TRequestVolumeDialogState suitable for streaming into.
Called to copy an object.

Parameters:

Takes no parameters.
const TRequestVolumeDialogState & source -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRequestVolumeDialogState::~TRequestVolumeDialogState

virtual ~ TRequestVolumeDialogState ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRequestVolumeDialogState::operator>>=

TStream & operator >>=(TStream & destination) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & destination -The destination stream.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRequestVolumeDialogState::operator<<=

TStream & operator <<= (TStream & source)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & source -The source stream.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws TInvalidVersionError if the version of the flattened object is not supported.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.