MM_VOLUME_RETURN_CONFIG_DIALOG

Obtains this volume configuration information, which includes some default values for volume creation.

Parameters

Parameters to MM_ObjectControl for this operation are as follows:

objectID
The OBID of the file system application to return the configuration information.
operation
Set to MM_VOLUME_RETURN_CONFIG_DIALOG.
parameter1
The OBID of the logical partition on which the volume is to be created.
parameter2
Set to zero.
parameter3
Set to zero.
bufferLength
Set to zero.
buffer
The address of a VolumeConfigElementList structure pointer.

Return Values

The following table lists return values and descriptions.

0x00000000

MM_OK

Remarks

Before a volume can be created, the file system must give to the application a description of the required information and a place to put the user/application input defining the volume to be created.

This information is typically used in a dialog with a user who can then modify the given default values and/or supply the details known only by the user, such as, volume capacity or volume name.

The configuration information is defined in the VolumeConfigElementList structure returned by this operation. Its contents are valid until a call to the operations MM_VOLUME_CREATE or MM_VOLUME_RETURN_TOKEN return the structure to the file system application.

The AdapterSpecificInfoDef structure defines an element of volume configuration. Each element will supply a default value which is sometimes modifiable. The first element is always the volume name.

The ElementMenuList structure is employed in a menu element. An application would make the set of choices available to a user for selection.

In the data field of AdapterSpecificInfoDef structure is a type LONG, whose content is a zero-based index into the array of choices. The content of the data field identifies the default choice.