IPhotoAcquireSettings::SetSequencePaddingWidth method (photoacquire.h)

Article
02/22/2024

The SetSequencePaddingWidth method sets a value indicating how wide sequential fields in filenames will be.

Syntax

HRESULT SetSequencePaddingWidth(
  [in] DWORD dwWidth
);

Parameters

[in] dwWidth

Double word value containing the width of sequential fields.

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

If the value passed to SetSequencePaddingWidth is nonzero and the format string specified in SetOutputFileNameTemplate contains a sequential token, this method sets the width allotted for the sequential token. For example, given the template $(GroupTag)$(AcquisitionSequence).$(OriginalExtension), if padding is set to 0, a file name might appear as

"Image1.jpg"

If padding is set to 3, the file name may appear as

"Image   1.jpg"

Requirements

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