IStringTable::DeleteString method

The IStringTable::DeleteString method enables a snap-in to delete a specified string from the snap-in string table.

Syntax


HRESULT DeleteString(
  [in] MMC_STRING_ID StringID
);

Parameters

StringID [in]

The string to be deleted from the snap-in string table.

Return value

This method can return one of these values.

S_OK

The specified string was successfully deleted from the snap-in string table.

E_FAIL

The string ID is invalid.

Remarks

Strings in the string table are reference counted. For example, adding the string "My Text" to the string table will return an ID, such as 1234. Adding "My Text" to the string table a second time will return an ID of 1234 again, and the internal reference count for the string will be incremented. Two calls to IStringTable::DeleteString will be required to completely remove "My Text" from the snap-in string table.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

Mmc.h

DLL

Mmcndmgr.dll

See also

IStringTable
IStringTable::AddString
IStringTable::DeleteAllStrings

 

 

Show: