IPen​.SetDefaultSpan [Method]

Sets the default time span for this pen.

Defined As

• [VBA] SetDefaultSpan(weeks As Integer, days As Integer, hours As Integer, minutes As Integer, seconds As Integer, milliseconds As Integer)

• [Cicode] SetDefaultSpan (INT weeks, INT days, DATE hours, INT minutes, INT seconds, INT milliseconds)

• [C++] HRESULT SetDefaultSpan (short weeks, short days, short hours, short minutes, short seconds, short milliseconds)

Parameters

weeks

[in] Indicates the number of weeks in the span.

days

[in] Indicates the number of days in the span.

hours

[in] Indicates the number of hours in the span.

minutes

[in] Indicates the number of minutes in the span.

seconds

[in] Indicates the number of seconds in the span.

milliseconds

[in] Indicates the number of milliseconds in the span.

Execution Result

If the function succeeds the return value will be Success. If an argument is bad then the return value will be InvalidArgument. If the pen is deleted then the return value will be GeneralFailure.

Calling Syntax

Assumes you have passed a valid pen object into the function.

[VBA]

Sub Example(pen As Object)
` Set span to 2 hours and 30 minutes
pen.GetDefaultSpan 0, 0, 2, 30, 0, 0
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
// Set span to 2 hours and 30 minutes
_ObjectCallMethod(hPen, "SetDefaultSpan", 0, 0, 2, 30, 0, 0);
END

See Also

IPen.GetDefaultSpan [Method]

IPen.ResetToDefaultSpan [Method]