IPhotoAcquireSettings::GetSequencePaddingWidth method (photoacquire.h)

  • Article

The GetSequencePaddingWidth method retrieves a value indicating how wide sequential fields in file names will be.

Syntax

HRESULT GetSequencePaddingWidth(
  [out] DWORD *pdwWidth
);

Parameters

[out] pdwWidth

Pointer to a 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.
E_POINTER
 A non-NULL value was expected.

Remarks

If the format string specified in SetOutputFileNameTemplate contains a sequential token, this method gets the width allotted for the sequential token.

If the format string does not contain a sequential token, the value returned by this method is not defined.

Requirements

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

See also

IPhotoAcquireSettings Interface

SetSequencePaddingWidth