Edit

FreeKnownFolderDefinitionFields function (shobjidl_core.h)

  • Article

Frees the allocated fields in the result from IKnownFolder::GetFolderDefinition.

Syntax

void FreeKnownFolderDefinitionFields(
  [in] KNOWNFOLDER_DEFINITION *pKFD
);

Parameters

[in] pKFD

Type: KNOWNFOLDER_DEFINITION*

A pointer to a KNOWNFOLDER_DEFINITION structure that contains information about the given known folder.

Return value

None

Remarks

This is an inline helper function that calls CoTaskMemFree on the fields in the structure that need to be freed. Its implementation can be seen in the header file.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header shobjidl_core.h (include Shobjidl.h)

See also

Known Folders Sample