Edit

Share via

IFsiItem::FileSystemName method (imapi2fs.h)

  • Article

Retrieves the name of the item as modified to conform to the specified file system.

Syntax

HRESULT FileSystemName(
  [in]  FsiFileSystems fileSystem,
  [out] BSTR           *pVal
);

Parameters

[in] fileSystem

File system to which the name should conform. For possible values, see the FsiFileSystems enumeration type.

[out] pVal

String that contains the name of the item as it conforms to the specified file system. The name in the IFsiItem::get_Name property is modified if the characters used and its length do not meet the requirements of the specified file system type.

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
E_POINTER
 Pointer is not valid.

Value: 0x80004003
IMAPI_E_INVALID_PARAM
 The value specified for parameter %1!ls! is not valid.

Value: 0xC0AAB101

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

IFsiItem