IFileOperation::RenameItem-Methode (shobjidl_core.h)
Deklariert ein einzelnes Element, dem ein neuer Anzeigename zugewiesen werden soll.
Syntax
HRESULT RenameItem(
[in] IShellItem *psiItem,
[in] LPCWSTR pszNewName,
[in] IFileOperationProgressSink *pfopsItem
);
Parameter
[in] psiItem
Typ: IShellItem*
Zeiger auf ein IShellItem-Objekt , das das Quellelement angibt.
[in] pszNewName
Typ: LPCWSTR
Zeiger auf den neuen Anzeigenamen des Elements. Hierbei handelt es sich um eine Unicode-Zeichenfolge, die null beendet wird.
[in] pfopsItem
Typ: IFileOperationProgressSink*
Zeiger auf ein IFileOperationProgressSink-Objekt, das für status- und Fehlerbenachrichtigungen verwendet werden soll. Wenn Sie IFileOperation::Advise für den Gesamtvorgang aufrufen, sind dort status status und Fehlerbenachrichtigungen für den Umbenennungsvorgang enthalten. Legen Sie diesen Parameter daher auf NULL fest.
Rückgabewert
Typ: HRESULT
Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.
Hinweise
Diese Methode benennt das Element nicht um, sondern deklariert lediglich das element, das umbenannt werden soll. Um ein Objekt umzubenennen, müssen Sie mindestens die hier beschriebene Reihenfolge von Aufrufen ausführen:
- Rufen Sie IFileOperation::RenameItem auf, um den neuen Namen zu deklarieren.
- Rufen Sie IFileOperation::P erformOperations auf, um den Umbenennungsvorgang zu starten.
Anforderungen
| Unterstützte Mindestversion (Client) | Windows Vista [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows Server 2008 [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | shobjidl_core.h (shobjidl.h einschließen) |