DtObj SQL Server Reference Documentation
DtObj
Current Version: 11.6.0
Chilkat.DtObj
Store and edit the year, month, day, hour, minute, and second as
individual properties.
Use the UTC flag to indicate whether the stored fields represent UTC or
local time.
Use alternate month and year properties when working with
Save and restore the object using Chilkat's compact internal serialized
date/time representation.
Pass
Use this class as a simple container rather than a full date/time
calculation or timezone-conversion engine.
For an extended overview, see
DtObj Class Overview.
Represent a date/time as simple editable fields.
Chilkat.DtObj is a lightweight date/time value object used by
Chilkat methods that need to pass or return individual date and time fields.
It stores values such as year, month, day, hour, minute, and second, along
with a flag indicating whether the value represents UTC or local time. It
also provides a compact serialization format for saving and restoring the
date/time value.
Simple date fields
UTC or local time
Struct tm compatibility
struct tm-style date/time conventions.
Serialize and restore
Used by other classes
DtObj values to Chilkat methods that require explicit
date/time fields or return date/time information.
Small and focused
DtObj, set or read the individual date/time
fields, check whether the value is UTC or local time, and pass the object to
another Chilkat method. Use serialization only when the date/time value needs
to be saved and restored in Chilkat's compact internal format.
Object Creation
DECLARE @hr int
DECLARE @dtObj int
EXEC @hr = sp_OACreate 'Chilkat.DtObj', @dtObj OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- ... use @dtObj ...
EXEC @hr = sp_OADestroy @dtObjT-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as sp_OACreate 'Chilkat.DtObj.11' for Chilkat v11.*.*.
sp_OACreate returns an object token (an int) that is passed as the first argument of every sp_OAMethod, sp_OAGetProperty and sp_OASetProperty call, and released with sp_OADestroy. Objects returned by methods (such as an HttpResponse or JsonObject) are also tokens received through an int OUT parameter; they must likewise be destroyed, and the OUT parameter is NULL when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero @hr), sp_OAGetErrorInfo describes the error.
Data types: strings are nvarchar(4000); integers, booleans (1 or 0) and object tokens are int; dates are datetime. In the signatures on this page, @success, @iResult, @sResult and the like are the OUT variables receiving a method's return value, @iValue / @sValue receive or supply a property value, and the remaining @ variables are the method's arguments in order.
A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example DECLARE @tmp TABLE (outputLine ntext) followed by INSERT INTO @tmp EXEC sp_OAGetProperty @dtObj, 'LastErrorText'. See string length limitations for strings returned by sp_OAMethod calls.
Methods that pass or return raw byte arrays are not shown on this page, because varbinary(max) values cannot be exchanged through sp_OAMethod (see varbinary(max) limitation). Use the BinData-based alternatives (methods ending in Bd) or the base64 / hex string-encoded variants instead. Binary properties (such as LastBinaryResult) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*Async) methods and event callbacks are not available from SQL Server.
Properties
Day
EXEC sp_OASetProperty @dtObj, 'Day', @iValue
The day of the month. The valid values for this member are 1 through 31.
topDebugLogFilePath
EXEC sp_OASetProperty @dtObj, 'DebugLogFilePath', @sValue
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
Hour
EXEC sp_OASetProperty @dtObj, 'Hour', @iValue
The hour. The valid values for this member are 0 through 23.
topLastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
LastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
EXEC sp_OASetProperty @dtObj, 'LastMethodSuccess', @iValue
Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
LastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topMinute
EXEC sp_OASetProperty @dtObj, 'Minute', @iValue
The minute. The valid values for this member are 0 through 59.
topMonth
EXEC sp_OASetProperty @dtObj, 'Month', @iValue
The month. The valid values for this member are 1 through 12 where 1 = January and 12 = December.
topSecond
EXEC sp_OASetProperty @dtObj, 'Second', @iValue
The second. The valid values for this member are 0 through 59.
topStructTmMonth
EXEC sp_OASetProperty @dtObj, 'StructTmMonth', @iValue
The month. The valid values for this member are 0 through 11 where 0 = January and 11 = December.
topStructTmYear
EXEC sp_OASetProperty @dtObj, 'StructTmYear', @iValue
The year represented as the number of years since 1900.
topUtc
EXEC sp_OASetProperty @dtObj, 'Utc', @iValue
1 if this is a UTC time, otherwise 0 if this is a local time.
VerboseLogging
EXEC sp_OASetProperty @dtObj, 'VerboseLogging', @iValue
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Year
EXEC sp_OASetProperty @dtObj, 'Year', @iValue
The year, such as 2012.
topMethods
DeSerialize
Loads the date/time with a string having the format as produced by the Serialize method, which is a string of SPACE separated integers containing (in this order) year, month, day, hour, minutes, seconds, and a UTC flag having the value of 1/0.
topSerialize
Serializes the date/time to a us-ascii string that can be imported at a later time via the DeSerialize method. The format of the string returned by this method is not intended to match any published standard. It is formatted to a string with SPACE separated integers containing (in this order) year, month, day, hour, minutes, seconds, and a UTC flag having the value of 1/0.
Returns NULL on failure