IContact::GetPath Method

  • Article

Retrieves the file system path used to load this contact.

Syntax

HRESULT GetPath(      
    LPWSTR pszPath,
    DWORD cchContactID,
    DWORD *pdwcchPathRequired
);

Parameters

  • pszPath
    [in, out] User-allocated buffer to store the contact ID.
  • cchContactID
    [in] Specifies the allocated buffer size in characters.
  • pdwcchPathRequired
    [in, out] Upon failure due to insufficient buffer, contains the required size for pszPath.

Return Value

Returns one of the following values:

S_OK Success. pszPath contains the path.
E_UNEXPECTED Contact ID was not loaded from a file path.
ERROR_INSUFFICIENT_BUFFER Macro HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) returned when pszPath was not large enough to store the value. The required buffer size is stored in pdwcchPathRequired.