Edit

Share via

SHNAMEMAPPINGW structure (shellapi.h)

  • Article

Contains the old and new path names for each file that was moved, copied, or renamed by the SHFileOperation function.

Syntax

typedef struct _SHNAMEMAPPINGW {
  LPWSTR pszOldPath;
  LPWSTR pszNewPath;
  int    cchOldPath;
  int    cchNewPath;
} SHNAMEMAPPINGW, *LPSHNAMEMAPPINGW;

Members

pszOldPath

Type: LPTSTR

The address of a character buffer that contains the old path name.

pszNewPath

Type: LPTSTR

The address of a character buffer that contains the new path name.

cchOldPath

Type: int

The number of characters in pszOldPath.

cchNewPath

Type: int

The number of characters in pszNewPath.

Remarks

There are two versions of this structure, an ANSI version (SHFILEOPSTRUCTA) and a Unicode version (SHFILEOPSTRUCTW). The Unicode version is identical to the ANSI version, except that wide character strings (LPCWSTR) are used in place of ANSI character strings (LPCSTR). On Windows 98 and earlier, only the ANSI version is supported. On Microsoft Windows NT 4.0 and later, both the ANSI and Unicode versions of this structure are supported. SHNAMEMAPPINGA and SHNAMEMAPPINGW should never be used directly; the appropriate structure is redefined as SHNAMEMAPPING by the precompiler depending on whether the application is compiled for ANSI or Unicode.

Note

The shellapi.h header defines SHNAMEMAPPING as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Header shellapi.h

See also

SHFILEOPSTRUCT