Функция GetSystemWindowsDirectoryA (sysinfoapi.h)

Статья
11/20/2024

Извлекает путь к общему каталогу Windows в многопользовательской системе.

Эта функция предоставляется в первую очередь для обеспечения совместимости. Приложения должны хранить код в папке Program Files и постоянные данные в папке "Данные приложения" в профиле пользователя. Дополнительные сведения см. в ShGetFolderPath.

Синтаксис

UINT GetSystemWindowsDirectoryA(
  [out] LPSTR lpBuffer,
  [in]  UINT  uSize
);

Параметры

[out] lpBuffer

Указатель на буфер для получения пути. Этот путь не заканчивается обратной косой чертой, если каталог Windows не является корневым каталогом. Например, если каталог Windows называется Windows на диске C, путь к каталогу Windows, полученному этой функцией, — C:\Windows. Если система была установлена в корневом каталоге диска C, путь получен в C:.

[in] uSize

Максимальный размер буфера, указанного параметром lpBuffer, в TCHARs.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение является длиной строки, скопированной в буфер, в TCHARs, не включая завершающийся пустой символ.

Если длина превышает размер буфера, возвращаемое значение — это размер буфера, необходимый для хранения пути.

Если функция завершается ошибкой, возвращаемое значение равно нулю. Чтобы получить расширенные сведения об ошибке, вызовите GetLastError.

Замечания

В системе, работающей в службах терминалов, каждый пользователь имеет уникальный каталог Windows. Системный каталог Windows предоставляется всем пользователям, поэтому это каталог, в котором приложение должно хранить инициализацию и помочь файлам, которые применяются ко всем пользователям.

С помощью служб терминалов функция getSystemWindowsDirectory извлекает путь системного каталога Windows, а функция GetWindowsDirect ory getWindowsDirectory извлекает путь к каталогу Windows, который является частным для каждого пользователя. В однопользовательской системе GetSystemWindowsDirectory совпадает с GetWindowsDirectory.

Заметка

Заголовок sysinfoapi.h определяет GetSystemWindowsDirectory как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	sysinfoapi.h (включая Windows.h)
библиотеки	Kernel32.lib
DLL	Kernel32.dll

См. также

GetWindowsDirectory

SHGetFolderLocation

системные информационные функции

Поделиться через