[#BloombergLP-bdlt-CalendarLoader-load]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlt.adoc[bdlt]::xref:BloombergLP/bdlt/CalendarLoader.adoc[CalendarLoader]::load
:relfileprefix: ../../../
:mrdocs:

Load a named calendar into the specified result.

== Synopsis

Declared in `<bdlt_calendarloader.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
virtual
int
load(
    xref:BloombergLP/bdlt/PackedCalendar.adoc[PackedCalendar]* result,
    char const* calendarName) = 0;
----

== Description

Load, into the specified `result`, the calendar identified by the specified `calendarName`. Return 0 on success, and a non‐zero value otherwise. If the calendar corresponding to `calendarName` is not found, 1 is returned with no effect on `*result`. If a non‐zero value other than 1 is returned (indicating a different error), `*result` is valid, but its value is undefined.

== Return Value

0 on success, 1 if not found, other non‐zero on error

== Parameters

[cols="1,4"]
|===
| Name| Description
| *result*
| receives the loaded calendar
| *calendarName*
| name of the calendar to load
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#