Show/Hide TOC

IFileOperationRenameItem Method

Declares a single item that is to be given a new display name.

Definition

Namespace: DevCase.Win32.Interfaces
Assembly: DevCase.net48 (in DevCase.net48.dll) Version: 6.0.0.0 (6.0)
XMLNS for XAML: Not mapped to an xmlns.

C#Request Example

HResult RenameItem(
	IShellItem psiItem,
	string pszNewName,
	IFileOperationProgressSink pfopsItem
)

VBRequest Example

Function RenameItem ( 
	psiItem As IShellItem,
	pszNewName As String,
	pfopsItem As IFileOperationProgressSink
) As HResult

Dim instance As IFileOperation
Dim psiItem As IShellItem
Dim pszNewName As String
Dim pfopsItem As IFileOperationProgressSink

Dim returnValue As HResult

returnValue = instance.RenameItem(psiItem, 
	pszNewName, pfopsItem)

C++Request Example

HResult RenameItem(
	IShellItem^ psiItem, 
	String^ pszNewName, 
	IFileOperationProgressSink^ pfopsItem
)

F#Request Example

abstract RenameItem : 
        psiItem : IShellItem * 
        pszNewName : string * 
        pfopsItem : IFileOperationProgressSink -> HResult

ASP.NETRequest Example

No code example is currently available or this language may not be supported.

Parameters

psiItem IShellItem: Pointer to an IShellItem that specifies the source item.
pszNewName String: Pointer to the new display name of the item. This is a null-terminated, Unicode string.
pfopsItem IFileOperationProgressSink: Pointer to an IFileOperationProgressSink object to be used for status and failure notifications.
If you call Advise(IFileOperationProgressSink, UInt32) for the overall operation, progress status and error notifications for the rename operation are included there, so set this parameter to NULL.

Return Value

HResult
If this method succeeds, it returns S_OK. Otherwise, it returns an HResult error code.

IFileOperationRenameItem Method

Definition

Parameters

Return Value

See Also

Reference