Edit

Share via

IFileSystemImage::put_VolumeName method (imapi2fs.h)

Sets the volume name for this file system image.

Syntax

HRESULT put_VolumeName(
  [in] BSTR newVal
);

Parameters

[in] newVal

String that contains the volume name for this file system image.

Return value

S_OK is returned on success, but other success codes may be returned as a result of implementation. The following error codes are commonly returned on operation failure, but do not represent the only possible error values:

Return code Description
IMAPI_E_INVALID_VOLUME_NAME
 The value specified for parameter %1!ls! is not valid.

Value: 0xC0AAB101

Remarks

The string is limited to 15 characters. For ISO 9660 discs, the volume name can use the following characters:

  • "A" through "Z"
  • "0" through "9"
  • "_" (underscore)
For Joliet and UDF discs, the volume name can use the following characters:
  • "a" through "z"
  • "A" through "Z"
  • "0" through "9"
  • "." (period)
  • "_" (underscore)
If you do not specify a volume name, a default volume name is generated using the system date and time when the result object is created.

Requirements

Requirement Value
Minimum supported client Windows Vista, Windows XP with SP2 [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header imapi2fs.h

See also

IFileSystemImage

IFileSystemImage::get_ImportedVolumeName

IFileSystemImage::get_VolumeName