CeGetCanonicalPathName (Windows CE 5.0)

Send Feedback

This function returns the canonical form and the length of the canonical form of the specified path.

DWORD CeGetCanonicalPathName(LPCWSTRlpPathName,LPWSTRlpCanonicalPathName,DWORD cchCanonicalPathName,DWORD dwReserved);

Parameters

  • lpPathName
    [in] Pointer to a null-terminated string of at most MAX_PATH characters in length that specifies the path name to be canonicalized. If this parameter is NULL, CeGetCanonicalPathName fails and the last error is set to ERROR_INVALID_PARAMETER.
  • lpCanonicalPathName
    [out] Optional. Pointer to a buffer that receives the canonical path name. If this parameter is not NULL and CeGetCanonicalPathName succeeds, the buffer pointed to by lpCanonicalPathName will contain a null-terminated string of length equal to that returned by CeGetCanonicalPathName.
  • cchCanonicalPathName
    [in] Value equal to the size of the buffer pointed to by lpCanonicalPathName. If lpCanonicalPathName is not NULL and if cchCanonicalPathName is less than the length of the canonical path name, CeGetCanonicalPath name fails and the last error is set to ERROR_INSUFFICIENT_BUFFER.
  • dwReserved
    [in] Reserved for future use.

Return Values

If the function succeeds, the length of the canonicalized version of lpPathName is returned. If lpCanonicalPathName is not NULL, then the canonicalized version of lpPathName is stored in lpCanonicalPathName. If this function is unsuccessful, a value of zero is returned.

Requirements

OS Versions: Windows CE 5.0 and later.
Header: Winbase.h
Link Library: Coredll.lib.

See Also

File I/O Functions

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.