CeGetCanonicalPathName
A version of this page is also available for
4/8/2010
This function returns the canonical form and the length of the canonical form of the specified path.
Syntax
DWORD CeGetCanonicalPathName(
LPCWSTR lpPathName,
LPWSTR lpCanonicalPathName,
DWORD cchCanonicalPathName,
DWORD dwReserved
);
Parameters
- lpPathName
[in] Pointer to the input null-terminated string of at most MAX_PATH characters in length that will be returned in canonical form. If this parameter is set to NULL, this function fails, and GetLastError returns ERROR_INVALID_PARAMETER.
- lpCanonicalPathName
[out] Optional. Pointer to a buffer that receives the canonical path. If this parameter is not set to NULL and this function succeeds, the buffer pointed to by lpCanonicalPathName contains a null-terminated string of length equal to that returned by this function.
- cchCanonicalPathName
[in] Size of the buffer pointed to by lpCanonicalPathName. If lpCanonicalPathName is not set to NULL and cchCanonicalPathName is less than the length of the canonical path, this funciton name fails, and GetLastError returns ERROR_INSUFFICIENT_BUFFER.
- dwReserved
[in] Reserved for future use.
Return Value
The length of the canonical path indicates success. If lpCanonicalPathName is not set to NULL, the canonical path is stored in lpCanonicalPathName. Zero indicates failure.
Requirements
| Header | winbase.h |
| Library | coredll.lib |
| Windows Embedded CE | Windows CE 5.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |