IPen​.GetDefaultSpan [Method]

Returns the default time span for this pen as a series of time components.

Defined As

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

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

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

Parameters

weeks

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

days

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

hours

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

minutes

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

seconds

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

milliseconds

[out] 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, the return value will be InvalidArgument. If the pen is deleted, the return value will be GeneralFailure. If any other unexpected error occurs, 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)
Dim weeks As Integer
Dim days As Integer
Dim hours As Integer
Dim minutes As Integer
Dim seconds As Integer
Dim milliseconds As Integer
pen.GetDefaultSpan weeks, days, hours, minutes, seconds, milliseconds
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
INT weeks;
INT days;
INT hours;
INT minutes;
INT seconds;
INT milliseconds;
_ObjectCallMethod(hPen, "GetDefaultSpan", weeks, days, hours, minutes,
seconds, milliseconds);
END

See Also

IPen.SetDefaultSpan [Method]

IPen.ResetToDefaultSpan [Method]