PathIsSlowW function (shlobj.h)

Article
02/22/2024

[PathIsSlow is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

Determines whether a file path is a high-latency network connection.

Syntax

BOOL PathIsSlowW(
  [in] LPCWSTR pszFile,
       DWORD   dwAttr
);

Parameters

[in] pszFile

Type: LPCTSTR

A pointer to a null-terminated string that contains the fully qualified path of the file.

dwAttr

Type: DWORD

The file attributes, if known; otherwise, pass –1 and this function gets the attributes by calling GetFileAttributes. See GetFileAttributes for a list of file attributes.

Return value

Type: BOOL

Returns TRUE if the connection is high-latency; otherwise, FALSE.

Remarks

A path is considered slow if the MultinetGetConnectionPerformance function returns a dwSpeed of 400 or less in its NETCONNECTINFOSTRUCT structure—this is the speed of the media to the network resource, in 100 bits-per-second (bps)—or if FILE_ATTRIBUTE_OFFLINE is set on the file.

Note that network conditions can impact function performance time.

Note

The shlobj.h header defines PathIsSlow as an alias that 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 is 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 Server 2003 [desktop apps only]
Target Platform	Windows
Header	shlobj.h
Library	Shell32.lib
DLL	Shell32.dll (version 5.0 or later)

Share via