Write the ISO 8601 representation of the specified object to buffer.

Synopsis

Declared in <bdlt_iso8601util.h>

static
int
generate(
    char* buffer,
    ssize_t bufferLength,
    bsls::TimeInterval const& object);

Description

Write the ISO 8601 representation of the specified object to the specified buffer of the specified bufferLength (in bytes), truncating (if necessary) to bufferLength. Optionally specify a configuration to affect the format of the generated string. If configuration is not supplied, the process‐wide default value Iso8601UtilConfiguration::defaultConfiguration() is used. Return the number of characters in the formatted string before truncation (not counting a null terminator). If bufferLength indicates sufficient capacity, buffer is null terminated. The behavior is undefined unless 0 <= bufferLength. Note that a buffer of size k_MAX_STRLEN + 1 is large enough to hold any string generated by this component (counting a null terminator, if any).

Return Value

the number of characters in the formatted string

Parameters

Name

Description

buffer

output buffer for the generated ISO 8601 text

bufferLength

capacity of buffer in bytes

object

value to format

Created with MrDocs