IStringTable::GetString method (mmc.h)

Article
02/22/2024

The IStringTable::GetString method enables a snap-in to retrieve a string from the snap-in's string table.

Syntax

HRESULT GetString(
  [in]  MMC_STRING_ID StringID,
  [in]  ULONG         cchBuffer,
  [out] LPOLESTR      lpBuffer,
  [out] ULONG         *pcchOut
);

Parameters

[in] StringID

The ID of the string to be retrieved from the snap-in's string table.

[in] cchBuffer

The number of characters in lpBuffer.

[out] lpBuffer

A pointer to the buffer for the character string.

[out] pcchOut

The number of characters in the retrieved string, not including the NULL terminator. If the number of characters written is not required, pass NULL for this parameter.

Return value

This method can return one of these values.

Remarks

If lpBuffer is not large enough to hold the entire string corresponding to StringID, as much of the string as will fit is copied to the buffer and is null-terminated.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	mmc.h
DLL	Mmcndmgr.dll

Share via