CeGetCanonicalPathName

9/8/2008

Essa função retorna a forma canônica e o comprimento da forma canônica do caminho especificado.

Syntax

DWORD CeGetCanonicalPathName(
  LPCWSTR lpPathName, 
  LPWSTR lpCanonicalPathName,
  DWORD cchCanonicalPathName,
  DWORD dwReserved
);

Parameters

• lpPathName
  [no] Ponteiro para a entrada seqüência de caracteres NULL-Terminated de at Most MAX_PATH caracteres de comprimento que será retornado em forma canônica. Se este parâmetro for definido como NULL, essa função falha e GetLastError retorna ERROR_INVALID_PARAMETER.

• lpCanonicalPathName
  [out] Opcional. Ponteiro para uma reserva que recebe o caminho canônico. Se este parâmetro não for definido como NULL e essa função é bem-sucedida, a reserva apontado por lpCanonicalPathName Contém um seqüência de caracteres NULL-Terminated de tamanho igual ao que retornado por essa função.

• cchCanonicalPathName
  [no] Tamanho da reserva apontado pelo lpCanonicalPathName. Se lpCanonicalPathName não está definida para NULL e cchCanonicalPathName é menor do que o comprimento do caminho canônico, esse nome função falha, e GetLastError retorna ERROR_INSUFFICIENT_BUFFER.

• dwReserved
  [no] Reservado para uso futuro.

Return Value

O comprimento do caminho canônico indica sucesso. Se lpCanonicalPathName não está definida para NULL, o caminho canônico é armazenado no lpCanonicalPathName. Zero indica falha.

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

See Also

Reference

File I/O Functions