Метод IQueryAssociations::GetString (shlwapi.h)
Ищет и извлекает строку, связанную с файлом или протоколом, из реестра.
Синтаксис
HRESULT GetString(
[in] ASSOCF flags,
[in] ASSOCSTR str,
[in, optional] LPCWSTR pszExtra,
[out, optional] LPWSTR pszOut,
[in, out] DWORD *pcchOut
);
Параметры
[in] flags
Тип: ASSOCF
Флаг, который можно использовать для управления поиском. Это может быть любое сочетание следующих значений ASSOCF .
- ASSOCF_IGNOREBASECLASS
- ASSOCF_NOFIXUPS
- ASSOCF_NOTRUNCATE
- ASSOCF_NOUSERSETTINGS
- ASSOCF_REMAPRUNDLL
- ASSOCF_VERIFY
[in] str
Тип: ASSOCSTR
Значение ASSOCSTR , указывающее тип возвращаемой строки.
[in, optional] pszExtra
Тип: LPCWSTR
Указатель на необязательную строку Юникода со значением NULL с информацией о расположении строки. Обычно для него задается команда оболочки, например open. Присвойте этому параметру значение NULL , если он не используется.
[out, optional] pszOut
Тип: LPWSTR
Указатель на строку Юникода, завершаемую null, которая используется для возврата запрошенной строки. Присвойте этому параметру значение NULL , чтобы получить требуемый размер буфера.
[in, out] pcchOut
Тип: DWORD*
Указатель на значение, которое при входе задается на количество символов в буфере pwszOut . При успешном возврате функция указывает на количество символов, помещенных в буфер.
Если флаг ASSOCF_NOTRUNCATE задан в флагах и буфер, указанный в pwszOut , слишком мал, функция возвращает E_POINTER и pcchOut указывает на требуемый размер буфера.
Если pwszOut имеет значение NULL, функция возвращает S_FALSE и pcchOut указывает на требуемый размер буфера.
Возвращаемое значение
Тип: HRESULT
Возвращает стандартное значение ошибки COM, включая следующее:
Ошибка | Значение |
---|---|
S_OK | Успешно. |
E_POINTER | Буфер pwszOut слишком мал для хранения всей строки. |
S_FALSE | pwszOut имеет значение NULL. pcchOut содержит требуемый размер буфера. |
Требования
Требование | Значение |
---|---|
Минимальная версия клиента | Windows 2000 Professional, Windows XP [только классические приложения] |
Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
Целевая платформа | Windows |
Header | shlwapi.h |
Библиотека | Shlwapi.lib |
DLL | Shell32.dll (версия 5.0 или более поздняя) |