title | description | ms.date | ms.assetid |
---|---|---|---|
IWpfSettings::GetStringProperty Method |
Describes the IWpfSettings::GetStringProperty method and details its syntax, parameters, return value, remarks, and requirements. |
10/07/2016 |
45f47ea3-1a10-6bad-326d-45ca18b7e24c |
Retrieves a string value from the worker process or application pool settings.
virtual HRESULT GetStringProperty(
IN WPF_SETTINGS_STRING_ENUM SettingId,
__out_ecount_opt(*pcchSetting) PWSTR pszSetting,
IN OUT DWORD* pcchSetting
) = 0;
SettingId
[IN] A WPF_SETTINGS_STRING_ENUM value that specifies which string value to return.
pszSetting
[OUT] A pointer to a string buffer that receives the value specified by SettingId
.
pcchSetting
[IN][OUT] A pointer to a DWORD
buffer that receives the size of the string returned in pszSetting
.
An HRESULT
. Possible values include, but are not limited to, those in the following table.
Value | Description |
---|---|
S_OK | Indicates that the operation was successful. |
ERROR_INSUFFICIENT_BUFFER | Indicates that there is not enough buffer space to perform the operation. |
ERROR_INVALID_PARAMETER | Indicates that the specified parameter is not valid. (The parameter is either out of range or not a string.) |
Because the pszSetting
parameter is optional, it may be NULL. If the size of the string value exceeds the size specified by the pcchSetting
parameter, the method will return ERROR_INSUFFICIENT_BUFFER.
Type | Description |
---|---|
Client | - IIS 7.0 on [!INCLUDEwinvista] - IIS 7.5 on Windows 7 - IIS 8.0 on Windows 8 - IIS 10.0 on Windows 10 |
Server | - IIS 7.0 on [!INCLUDEwinsrv2008] - IIS 7.5 on Windows Server 2008 R2 - IIS 8.0 on Windows Server 2012 - IIS 8.5 on Windows Server 2012 R2 - IIS 10.0 on Windows Server 2016 |
Product | - IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0 - [!INCLUDEiisexp75], [!INCLUDEiisexp80], [!INCLUDEiisexp100] |
Header | Wpframework.h |
IWpfSettings Interface
IWpfSettings::GetBoolProperty Method
IWpfSettings::GetDwordProperty Method
IWpfSettings::GetHandleProperty Method
IWpfSettings::GetUlonglongProperty Method
WPF_SETTINGS_STRING_ENUM Enumeration