CMPIDateTimeFT Struct Reference

Function table of CMPIDateTime encapsulated data type object. More...

#include <cmpift.h>

Data Fields
CMPIVersion	ftVersion
	CMPI version supported by the MB for this function table. More...
CMPIStatus(*	release )(CMPIDateTime *dt)
	Release a CMPIDateTime object. More...
CMPIDateTime *(*	clone )(const CMPIDateTime *dt, CMPIStatus *rc)
	Create an independent copy of a CMPIDateTime object. More...
CMPIUint64(*	getBinaryFormat )(const CMPIDateTime *dt, CMPIStatus *rc)
	Get the value of a CMPIDateTime object in binary format. More...
CMPIString *(*	getStringFormat )(const CMPIDateTime *dt, CMPIStatus *rc)
	Get the value of a CMPIDateTime object in the string format defined for the CIM datetime type. More...
CMPIBoolean(*	isInterval )(const CMPIDateTime *dt, CMPIStatus *rc)
	Test whether a CMPIDateTime object contains an interval value. More...

Detailed Description

Function table of CMPIDateTime encapsulated data type object.

Field Documentation

CMPIVersion CMPIDateTimeFT::ftVersion

CMPI version supported by the MB for this function table.

Any earlier CMPI versions are implicitly also supported.

See CMPIVersion<NNN> for valid CMPI version numbers.

CMPIStatus(* CMPIDateTimeFT::release)(CMPIDateTime *dt)

Release a CMPIDateTime object.

CMPIDateTimeFT.release() releases a CMPIDateTime object. This indicates to the MB that the object (including any objects it contains) will no longer be used by the MI. The MB may free (=reclaim) the memory associated with the object during the call to this function, or later during some garbage collection cycle (see Subclause 4.1.7 of the CMPI Standard).

Parameters

dt	Points to the CMPIDateTime object that is to be released. That object shall have been created using CMPIDateTimeFT.clone().

Returns

CMPIStatus structure containing the function return status.

Errors

The function return status will indicate one of the following CMPIrc codes:

• CMPI_RC_OK - Function successful.
• CMPI_RC_ERR_INVALID_HANDLE - The dt handle is invalid.

Convenience Function

CMRelease()

CMPIDateTime*(* CMPIDateTimeFT::clone)(const CMPIDateTime *dt, CMPIStatus *rc)

Create an independent copy of a CMPIDateTime object.

CMPIDateTimeFT.clone() creates an independent copy of a CMPIDateTime object.

Parameters

	dt	Points to the CMPIDateTime object that is to be copied.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a pointer to the copied CMPIDateTime object will be returned.

The returned CMPIDateTime object shall be explicitly released by the MI using CMPIDateTimeFT.release().

If not successful, NULL will be returned.

Errors

The function return status will indicate one of the following CMPIrc codes:

• CMPI_RC_OK - Function successful.
• CMPI_RC_ERR_INVALID_HANDLE - The dt handle is invalid.

Convenience Function

CMClone()

CMPIUint64(* CMPIDateTimeFT::getBinaryFormat)(const CMPIDateTime *dt, CMPIStatus *rc)

Get the value of a CMPIDateTime object in binary format.

CMPIDateTimeFT.getBinaryFormat() gets the value of a CMPIDateTime object as a 64-bit unsigned integer in microseconds starting since 00:00:00 GMT, January 1, 1970, or as an interval in microseconds, depending on what kind of value the CMPIDateTime object contains.

Parameters

	dt	Points to the CMPIDateTime object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a CMPIUint64 value containing the value of the CMPIDateTime object in binary format will be returned.

If not successful, 0 will be returned.

Errors

The function return status will indicate one of the following CMPIrc codes:

• CMPI_RC_OK - Function successful.
• CMPI_RC_ERR_INVALID_HANDLE - The dt handle is invalid.

Convenience Function

CMGetBinaryFormat()

CMPIString*(* CMPIDateTimeFT::getStringFormat)(const CMPIDateTime *dt, CMPIStatus *rc)

Get the value of a CMPIDateTime object in the string format defined for the CIM datetime type.

CMPIDateTimeFT.getStringFormat() gets the value of a CMPIDateTime object as a string in the format defined in DSP0004 for the CIM datetime type.

Parameters

	dt	Points to the CMPIDateTime object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a pointer to a CMPIString object containing the value of a CMPIDateTime object in the format defined in DSP0004 for the CIM datetime type will be returned.

The returned CMPIString object shall not be explicitly released by the MI, because it may be an internal object of the CMPIDateTime object which will be released along with that object, or a new object created by the MB which will be released automatically by the MB (see Subclause 4.1.7 of the CMPI Standard).

If not successful, NULL will be returned.

Errors

The function return status will indicate one of the following CMPIrc codes:

• CMPI_RC_OK - Function successful.
• CMPI_RC_ERR_INVALID_HANDLE - The dt handle is invalid.

Convenience Function

CMGetStringFormat()

CMPIBoolean(* CMPIDateTimeFT::isInterval)(const CMPIDateTime *dt, CMPIStatus *rc)

Test whether a CMPIDateTime object contains an interval value.

CMPIDateTimeFT.isInterval() tests whether a CMPIDateTime object contains an interval value.

Parameters

	dt	Points to the CMPIDateTime object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a CMPIBoolean value indicating the test result will be returned, as follows:

• True indicates that the CMPIDateTime object contains an interval value;
• False indicates that this is not an interval.

If not successful, false will be returned.

Errors

The function return status will indicate one of the following CMPIrc codes:

• CMPI_RC_OK - Function successful.
• CMPI_RC_ERR_INVALID_HANDLE - The dt handle is invalid.

Convenience Function

CMIsInterval()

---

The documentation for this struct was generated from the following file:

• cmpift.h