Export (0) Print
Expand All

PathParseIconLocation function

Parses a file location string that contains a file location and icon index, and returns separate values.

Syntax


int PathParseIconLocation(
  _Inout_  LPTSTR pszIconFile
);

Parameters

pszIconFile [in, out]

Type: LPTSTR

A pointer to a null-terminated string of length MAX_PATH that contains a file location string. It should be in the form "path,iconindex". When the function returns, pszIconFile will point to the file's path.

Return value

Type: int

Returns the valid icon index value.

Remarks

This function is useful for taking a DefaultIcon value retrieved from the registry by SHGetValue and separating the icon index from the path.

Examples


#include <windows.h>
#include <iostream.h>
#include "Shlwapi.h"

void main(void)
{
// Path to parse for file and icon index.
char buffer_1[ ] = "C:\\TEST\\sample.txt,3"; 
char *lpStr1;
lpStr1 = buffer_1;

// Return value from "PathParseIconLocation".
int retval;

// Search a path to parse for file and icon index.
retval = PathParseIconLocation(lpStr1);
cout << "The path to parse for file and icon index is   : " << lpStr1 << endl;
cout << "PathParseIconLocation returns the icon index of: " << retval << endl;
}

OUTPUT:
==========
The path to parse for file and icon index is   : C:\TEST\sample.txt
PathParseIconLocation returns the icon index of: 3

Requirements

Minimum supported client

Windows 2000 Professional, Windows XP [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Shlwapi.h

Library

Shlwapi.lib

DLL

Shlwapi.dll (version 4.71 or later)

Unicode and ANSI names

PathParseIconLocationW (Unicode) and PathParseIconLocationA (ANSI)

 

 

Community Additions

ADD
Show:
© 2014 Microsoft