Contents Index Topic Contents | ||
Previous Topic: IShellFolder::GetUIObjectOf Next Topic: IShellFolder::SetNameOf |
IShellFolder::ParseDisplayName
HRESULT ParseDisplayName( HWND hwndOwner, LPBC pbcReserved, LPOLESTR lpszDisplayName, ULONG *pchEaten, LPITEMIDLIST *ppidl, ULONG *pdwAttributes );Translates a file object's or folder's display name into an item identifier list.
- Returns NOERROR if successful, or an OLE-defined error value otherwise.
- hwndOwner
- Handle to the owner window that the client should specify if it displays a dialog box or message box.
- pbcReserved
- Reserved; this parameter is always NULL.
- lpszDisplayName
- Address of a null-terminated UNICODE string specifying the display name. This parameter must be a display name for parsingthat is, a display name retrieved using the SHGDN_FORPARSING value.
- pchEaten
- Address of a ULONG value that receives the number of characters of the display name that was parsed.
- ppidl
- Address of an ITEMIDLIST pointer that receives the item identifier list created for the object. The returned item identifier list specifies the item relative to the parsing folder. If the name to be parsed exists within the parsing folder, then the returned item identifier list will contain only one element. If the name to be parsed exists within a sub-folder of the parsing folder, then the returned item identifier list will contain multiple elements. If an error occurs, NULL is returned in this address.
- pdwAttributes
- Address of the attributes of the file object. Can be NULL if the caller does not need attribute data.
This method is similar to the IParseDisplayName::ParseDisplayName method defined by OLE.
See also IShellFolder, IShellLink
Top of Page
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.