[#CBanDB-Read]
= xref:CBanDB.adoc[CBanDB]::Read
:relfileprefix: ../
:mrdocs:

Read the banlist from disk.

== Synopsis

Declared in `<addrdb.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
Read(xref:banmap_t.adoc[banmap_t]& banSet);
----

== Return Value

true on success

== Parameters

[cols="1,4"]
|===
| Name| Description
| *banSet* [out]
| The loaded list. Set if `true` is returned, otherwise it is left in an undefined state.
|===


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