IPhotoAcquireSettings::SetGroupTag method (photoacquire.h)

  • Article

The SetGroupTag method sets the group tag for an acquisition session.

Syntax

HRESULT SetGroupTag(
  [in] LPCWSTR pszGroupTag
);

Parameters

[in] pszGroupTag

Pointer to a null-terminated string containing the group tag.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
 The method succeeded.

Remarks

The group tag is stored as a keyword in each file's metadata. It is also used in the file name if the $(GroupTag) token is present in the format string passed to SetOutputFileNameTemplate.

Requirements

Requirement Value
Target Platform Windows
Header photoacquire.h
Library PhotoAcquireUID.lib

See also

GetGroupTag

IPhotoAcquireSettings Interface