The UtilLoadStringWithAlloc function allocates and loads a string out of the resource table.
Syntax
HRESULT UtilLoadStringWithAlloc(
_In_ UINT uID,
_Out_ LPWSTR *ppwzBuffer,
_In_ UINT cchBufferMax
);
Parameters
uID [in]
Type: UINT
Identifier of the string to be loaded.
ppwzBuffer [out]
Type: LPWSTR*
The location where the newly allocated string will be placed. The string must be freed using CoTaskMemFree when it is no longer needed.
cchBufferMax [in]
Type: UINT
The maximum number of characters to load from the resource table. If the resource string is longer than the number of characters specified, it is truncated and null-terminated.
Note:
This parameter may not be set to zero.
Return value
Type: HRESULT
Possible return values include, but are not limited to, the following.
| Return code | Description |
|---|---|
| S_OK | The operation succeeded. |
| E_INVALIDARG | One or more parameters has not been provided correctly. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8 [desktop apps only] |
| Minimum supported server | Windows Server 2012 [desktop apps only] |
| Header | Ndattributils.h |
See also
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
