IEnhancedStorageSiloAction::GetDescription method (ehstorapi.h)

  • Article

Returns a descriptive string for the action specified by the IEnhancedStorageSiloAction object.

Syntax

HRESULT GetDescription(
  [out] LPWSTR *ppwszActionDescription
);

Parameters

[out] ppwszActionDescription

Pointer to a string that describes the silo action.

Return value

This method can return one of these values.

Return code Description
S_OK
 The descriptive string was retrieved successfully.
E_INVALIDARG
 The ppwszDescription parameter is NULL.

Remarks

The description string is brief, consisting of one or two short sentences, and is suitable for display in a UI element such as tooltip or small static text box.

When the caller no longer requires access to the string, this buffer must be freed by passing this pointer to CoTaskMemFree.

Requirements

Requirement Value
Minimum supported client Windows Vista with SP2 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header ehstorapi.h

See also

IEnhancedStorageSiloAction