~zulcss/samba/server-dailies-3.4

<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#0b5d6cdc7587e2d27a30f5cdc4a91931">iniparser_getnsec</a> (dictionary *d)</td></tr>

<tr><td class="mdescLeft"> </td><td class="mdescRight">Get number of sections in a dictionary. <a href="#0b5d6cdc7587e2d27a30f5cdc4a91931"></a><br></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#393212be805f395bbfdeb1bafa8bb72a">iniparser_getsecname</a> (dictionary *d, int n)</td></tr>

<tr><td class="mdescLeft"> </td><td class="mdescRight">Get name for section n in a dictionary. <a href="#393212be805f395bbfdeb1bafa8bb72a"></a><br></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#ece0e32de371c9e9592d8333f816dfac">iniparser_dump_ini</a> (dictionary *d, FILE *f)</td></tr>

<tr><td class="mdescLeft"> </td><td class="mdescRight">Save a dictionary to a loadable ini file. <a href="#ece0e32de371c9e9592d8333f816dfac"></a><br></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#046436b3489cd8854ba8e29109250324">iniparser_dump</a> (dictionary *d, FILE *f)</td></tr>

<tr><td class="mdescLeft"> </td><td class="mdescRight">Dump a dictionary to an opened file pointer. <a href="#046436b3489cd8854ba8e29109250324"></a><br></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#587eafb48937fdee8ae414ad7a666db8">iniparser_getstr</a> (dictionary *d, const char *key)</td></tr>

<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the string associated to a key, return NULL if not found. <a href="#587eafb48937fdee8ae414ad7a666db8"></a><br></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#7894f8480e1f254d4a1b4a31bdc51b46">iniparser_getstring</a> (dictionary *d, const char *key, char *def)</td></tr>

<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the string associated to a key. <a href="#7894f8480e1f254d4a1b4a31bdc51b46"></a><br></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#694eb1110f4200db8648820a0bb405fa">iniparser_getint</a> (dictionary *d, const char *key, int notfound)</td></tr>

<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the string associated to a key, convert to an int. <a href="#694eb1110f4200db8648820a0bb405fa"></a><br></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#480d35322f1252344cf2246ac21ee559">iniparser_getdouble</a> (dictionary *d, char *key, double notfound)</td></tr>

<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the string associated to a key, convert to a double. <a href="#480d35322f1252344cf2246ac21ee559"></a><br></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#eb93c13fcbb75efaa396f53bfd73ff4d">iniparser_getboolean</a> (dictionary *d, const char *key, int notfound)</td></tr>

<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the string associated to a key, convert to a boolean. <a href="#eb93c13fcbb75efaa396f53bfd73ff4d"></a><br></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#605a88057bac4c3249513fc588421c32">iniparser_setstr</a> (dictionary *ini, char *entry, char *val)</td></tr>

<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an entry in a dictionary. <a href="#605a88057bac4c3249513fc588421c32"></a><br></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#7b1a7f2492a35043867fa801b8f21e52">iniparser_unset</a> (dictionary *ini, char *entry)</td></tr>

<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete an entry in a dictionary. <a href="#7b1a7f2492a35043867fa801b8f21e52"></a><br></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#3d67c98bbc0cb5239f024ad54bdc63f1">iniparser_find_entry</a> (dictionary *ini, char *entry)</td></tr>

<tr><td class="mdescLeft"> </td><td class="mdescRight">Finds out if a given entry exists in a dictionary. <a href="#3d67c98bbc0cb5239f024ad54bdc63f1"></a><br></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">dictionary * </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#b0be559bfb769224b3f1b75e26242a67">iniparser_load</a> (const char *ininame)</td></tr>

<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse an ini file and return an allocated dictionary object. <a href="#b0be559bfb769224b3f1b75e26242a67"></a><br></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#90549ee518523921886b74454ff872eb">iniparser_freedict</a> (dictionary *d)</td></tr>

<tr><td class="mdescLeft"> </td><td class="mdescRight">Free all memory associated to an ini dictionary. <a href="#90549ee518523921886b74454ff872eb"></a><br></td></tr>

</table>

<hr><a name="_details"></a><h2>Detailed Description</h2>

Parser for ini files.

<p>

<dl class="author" compact><dt><b>Author:</b></dt><dd>N. Devillard </dd></dl>

<dl class="version" compact><dt><b>Version:</b></dt><dd><dl class="rcs" compact><dt><b>Revision</b></dt><dd>1.23 </dd></dl>

</dd></dl>

<hr><h2>Function Documentation</h2>

<tr>

<td class="memname">void iniparser_dump </td>

<td class="paramtype">dictionary * </td>

</tr>

<tr>

</tr>

<tr>

</tr>

</table>

</div>

<p>

Dump a dictionary to an opened file pointer.

<p>

<dl compact><dt><b>Parameters:</b></dt><dd>

100

<tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to dump. </td></tr>

101

<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>Opened file pointer to dump to. </td></tr>

102

</table>

103

</dl>

104

<dl class="return" compact><dt><b>Returns:</b></dt><dd>void</dd></dl>

105

This function prints out the contents of a dictionary, one element by line, onto the provided file pointer. It is OK to specify <code>stderr</code> or <code>stdout</code> as output files. This function is meant for debugging purposes mostly.

106

</div>

107

</div><p>

108

109

110

111

112

<tr>

113

<td class="memname">void iniparser_dump_ini </td>

114

115

<td class="paramtype">dictionary * </td>

116

117

</tr>

118

<tr>

119

120

121

122

123

</tr>

124

<tr>

125

126

127

128

</tr>

129

</table>

130

</div>

131

132

133

<p>

134

Save a dictionary to a loadable ini file.

135

<p>

136

<dl compact><dt><b>Parameters:</b></dt><dd>

137

138

<tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to dump </td></tr>

139

<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>Opened file pointer to dump to </td></tr>

140

</table>

141

</dl>

142

<dl class="return" compact><dt><b>Returns:</b></dt><dd>void</dd></dl>

143

This function dumps a given dictionary into a loadable ini file. It is Ok to specify <code>stderr</code> or <code>stdout</code> as output files.

144

</div>

145

</div><p>

146

147

148

149

150

<tr>

151

<td class="memname">int iniparser_find_entry </td>

152

153

<td class="paramtype">dictionary * </td>

154

155

</tr>

156

<tr>

157

158

159

160

<td class="paramname"> <em>entry</em></td><td> </td>

161

</tr>

162

<tr>

163

164

165

166

</tr>

167

</table>

168

</div>

169

170

171

<p>

172

Finds out if a given entry exists in a dictionary.

173

<p>

174

<dl compact><dt><b>Parameters:</b></dt><dd>

175

176

<tr><td valign="top"></td><td valign="top"><em>ini</em> </td><td>Dictionary to search </td></tr>

177

<tr><td valign="top"></td><td valign="top"><em>entry</em> </td><td>Name of the entry to look for </td></tr>

178

</table>

179

</dl>

180

<dl class="return" compact><dt><b>Returns:</b></dt><dd>integer 1 if entry exists, 0 otherwise</dd></dl>

181

Finds out if a given entry exists in the dictionary. Since sections are stored as keys with NULL associated values, this is the only way of querying for the presence of sections in a dictionary.

182

</div>

183

</div><p>

184

185

186

187

188

<tr>

189

<td class="memname">void iniparser_freedict </td>

190

191

<td class="paramtype">dictionary * </td>

192

193

194

195

</tr>

196

</table>

197

</div>

198

199

200

<p>

201

Free all memory associated to an ini dictionary.

202

<p>

203

<dl compact><dt><b>Parameters:</b></dt><dd>

204

205

<tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to free </td></tr>

206

</table>

207

</dl>

208

<dl class="return" compact><dt><b>Returns:</b></dt><dd>void</dd></dl>

209

Free all memory associated to an ini dictionary. It is mandatory to call this function before the dictionary object gets out of the current context.

210

</div>

211

</div><p>

212

213

214

215

216

<tr>

217

<td class="memname">int iniparser_getboolean </td>

218

219

<td class="paramtype">dictionary * </td>

220

221

</tr>

222

<tr>

223

224

225

<td class="paramtype">const char * </td>

226

227

</tr>

228

<tr>

229

230

231

232

<td class="paramname"> <em>notfound</em></td><td> </td>

233

</tr>

234

<tr>

235

236

237

238

</tr>

239

</table>

240

</div>

241

242

243

<p>

244

Get the string associated to a key, convert to a boolean.

245

<p>

246

<dl compact><dt><b>Parameters:</b></dt><dd>

247

248

<tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to search </td></tr>

249

<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Key string to look for </td></tr>

250

<tr><td valign="top"></td><td valign="top"><em>notfound</em> </td><td>Value to return in case of error </td></tr>

251

</table>

252

</dl>

253

<dl class="return" compact><dt><b>Returns:</b></dt><dd>integer</dd></dl>

254

This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, the notfound value is returned.<p>

255

A true boolean is found if one of the following is matched:<p>

256

<ul>

257

<li>A string starting with 'y'</li><li>A string starting with 'Y'</li><li>A string starting with 't'</li><li>A string starting with 'T'</li><li>A string starting with '1'</li></ul>

258

<p>

259

A false boolean is found if one of the following is matched:<p>

260

<ul>

261

<li>A string starting with 'n'</li><li>A string starting with 'N'</li><li>A string starting with 'f'</li><li>A string starting with 'F'</li><li>A string starting with '0'</li></ul>

262

<p>

263

The notfound value returned if no boolean is identified, does not necessarily have to be 0 or 1.

264

</div>

265

</div><p>

266

267

268

269

270

<tr>

271

<td class="memname">double iniparser_getdouble </td>

272

273

<td class="paramtype">dictionary * </td>

274

275

</tr>

276

<tr>

277

278

279

280

281

</tr>

282

<tr>

283

284

285

<td class="paramtype">double </td>

286

<td class="paramname"> <em>notfound</em></td><td> </td>

287

</tr>

288

<tr>

289

290

291

292

</tr>

293

</table>

294

</div>

295

296

297

<p>

298

Get the string associated to a key, convert to a double.

299

<p>

300

<dl compact><dt><b>Parameters:</b></dt><dd>

301

302

<tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to search </td></tr>

303

<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Key string to look for </td></tr>

304

<tr><td valign="top"></td><td valign="top"><em>notfound</em> </td><td>Value to return in case of error </td></tr>

305

</table>

306

</dl>

307

<dl class="return" compact><dt><b>Returns:</b></dt><dd>double</dd></dl>

308

This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, the notfound value is returned.

309

</div>

310

</div><p>

311

312

313

314

315

<tr>

316

<td class="memname">int iniparser_getint </td>

317

318

<td class="paramtype">dictionary * </td>

319

320

</tr>

321

<tr>

322

323

324

<td class="paramtype">const char * </td>

325

326

</tr>

327

<tr>

328

329

330

331

<td class="paramname"> <em>notfound</em></td><td> </td>

332

</tr>

333

<tr>

334

335

336

337

</tr>

338

</table>

339

</div>

340

341

342

<p>

343

Get the string associated to a key, convert to an int.

344

<p>

345

<dl compact><dt><b>Parameters:</b></dt><dd>

346

347

<tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to search </td></tr>

348

<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Key string to look for </td></tr>

349

<tr><td valign="top"></td><td valign="top"><em>notfound</em> </td><td>Value to return in case of error </td></tr>

350

</table>

351

</dl>

352

<dl class="return" compact><dt><b>Returns:</b></dt><dd>integer</dd></dl>

353

This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, the notfound value is returned.<p>

354

Supported values for integers include the usual C notation so decimal, octal (starting with 0) and hexadecimal (starting with 0x) are supported. Examples:<p>

355

<ul>

356

<li>"42" -> 42</li><li>"042" -> 34 (octal -> decimal)</li><li>"0x42" -> 66 (hexa -> decimal)</li></ul>

357

<p>

358

Warning: the conversion may overflow in various ways. Conversion is totally outsourced to strtol(), see the associated man page for overflow handling.<p>

359

Credits: Thanks to A. Becker for suggesting strtol()

360

</div>

361

</div><p>

362

363

364

365

366

<tr>

367

<td class="memname">int iniparser_getnsec </td>

368

369

<td class="paramtype">dictionary * </td>

370

371

372

373

</tr>

374

</table>

375

</div>

376

377

378

<p>

379

Get number of sections in a dictionary.

380

<p>

381

<dl compact><dt><b>Parameters:</b></dt><dd>

382

383

<tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to examine </td></tr>

384

</table>

385

</dl>

386

<dl class="return" compact><dt><b>Returns:</b></dt><dd>int Number of sections found in dictionary</dd></dl>

387

This function returns the number of sections found in a dictionary. The test to recognize sections is done on the string stored in the dictionary: a section name is given as "section" whereas a key is stored as "section:key", thus the test looks for entries that do not contain a colon.<p>

388

This clearly fails in the case a section name contains a colon, but this should simply be avoided.<p>

389

This function returns -1 in case of error.

390

</div>

391

</div><p>

392

393

394

395

396

<tr>

397

<td class="memname">char* iniparser_getsecname </td>

398

399

<td class="paramtype">dictionary * </td>

400

401

</tr>

402

<tr>

403

404

405

406

407

</tr>

408

<tr>

409

410

411

412

</tr>

413

</table>

414

</div>

415

416

417

<p>

418

Get name for section n in a dictionary.

419

<p>

420

<dl compact><dt><b>Parameters:</b></dt><dd>

421

422

<tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to examine </td></tr>

423

<tr><td valign="top"></td><td valign="top"><em>n</em> </td><td>Section number (from 0 to nsec-1). </td></tr>

424

</table>

425

</dl>

426

<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to char string</dd></dl>

427

This function locates the n-th section in a dictionary and returns its name as a pointer to a string statically allocated inside the dictionary. Do not free or modify the returned string!<p>

428

This function returns NULL in case of error.

429

</div>

430

</div><p>

431

432

433

434

435

<tr>

436

<td class="memname">char* iniparser_getstr </td>

437

438

<td class="paramtype">dictionary * </td>

439

440

</tr>

441

<tr>

442

443

444

<td class="paramtype">const char * </td>

445

446

</tr>

447

<tr>

448

449

450

451

</tr>

452

</table>

453

</div>

454

455

456

<p>

457

Get the string associated to a key, return NULL if not found.

458

<p>

459

<dl compact><dt><b>Parameters:</b></dt><dd>

460

461

<tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to search </td></tr>

462

<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Key string to look for </td></tr>

463

</table>

464

</dl>

465

<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to statically allocated character string, or NULL.</dd></dl>

466

This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, NULL is returned. The returned char pointer is pointing to a string allocated in the dictionary, do not free or modify it.<p>

467

This function is only provided for backwards compatibility with previous versions of iniparser. It is recommended to use <a class="el" href="iniparser_8h.html#7894f8480e1f254d4a1b4a31bdc51b46">iniparser_getstring()</a> instead.

468

</div>

469

</div><p>

470

471

472

473

474

<tr>

475

<td class="memname">char* iniparser_getstring </td>

476

477

<td class="paramtype">dictionary * </td>

478

479

</tr>

480

<tr>

481

482

483

<td class="paramtype">const char * </td>

484

485

</tr>

486

<tr>

487

488

489

490

491

</tr>

492

<tr>

493

494

495

496

</tr>

497

</table>

498

</div>

499

500

501

<p>

502

Get the string associated to a key.

503

<p>

504

<dl compact><dt><b>Parameters:</b></dt><dd>

505

506

<tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to search </td></tr>

507

<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Key string to look for </td></tr>

508

<tr><td valign="top"></td><td valign="top"><em>def</em> </td><td>Default value to return if key not found. </td></tr>

509

</table>

510

</dl>

511

<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to statically allocated character string</dd></dl>

512

This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, the pointer passed as 'def' is returned. The returned char pointer is pointing to a string allocated in the dictionary, do not free or modify it.

513

</div>

514

</div><p>

515

516

517

518

519

<tr>

520

<td class="memname">dictionary* iniparser_load </td>

521

522

<td class="paramtype">const char * </td>

523

<td class="paramname"> <em>ininame</em> </td>

524

525

526

</tr>

527

</table>

528

</div>

529

530

531

<p>

532

Parse an ini file and return an allocated dictionary object.

533

<p>

534

<dl compact><dt><b>Parameters:</b></dt><dd>

535

536

<tr><td valign="top"></td><td valign="top"><em>ininame</em> </td><td>Name of the ini file to read. </td></tr>

537

</table>

538

</dl>

539

<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to newly allocated dictionary</dd></dl>

540

This is the parser for ini files. This function is called, providing the name of the file to be read. It returns a dictionary object that should not be accessed directly, but through accessor functions instead.<p>

541

The returned dictionary must be freed using <a class="el" href="iniparser_8h.html#90549ee518523921886b74454ff872eb">iniparser_freedict()</a>.

542

</div>

543

</div><p>

544

545

546

547

548

<tr>

549

<td class="memname">int iniparser_setstr </td>

550

551

<td class="paramtype">dictionary * </td>

552

553

</tr>

554

<tr>

555

556

557

558

<td class="paramname"> <em>entry</em>, </td>

559

</tr>

560

<tr>

561

562

563

564

565

</tr>

566

<tr>

567

568

569

570

</tr>

571

</table>

572

</div>

573

574

575

<p>

576

Set an entry in a dictionary.

577

<p>

578

<dl compact><dt><b>Parameters:</b></dt><dd>

579

580

<tr><td valign="top"></td><td valign="top"><em>ini</em> </td><td>Dictionary to modify. </td></tr>

581

<tr><td valign="top"></td><td valign="top"><em>entry</em> </td><td>Entry to modify (entry name) </td></tr>

582

<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>New value to associate to the entry. </td></tr>

583

</table>

584

</dl>

585

<dl class="return" compact><dt><b>Returns:</b></dt><dd>int 0 if Ok, -1 otherwise.</dd></dl>

586

If the given entry can be found in the dictionary, it is modified to contain the provided value. If it cannot be found, -1 is returned. It is Ok to set val to NULL.

587

</div>

588

</div><p>

589

590

591

592

593

<tr>

594

<td class="memname">void iniparser_unset </td>

595

596

<td class="paramtype">dictionary * </td>

597

598

</tr>

599

<tr>

600

601

602

603

<td class="paramname"> <em>entry</em></td><td> </td>

604

</tr>

605

<tr>

606

607

608

609

</tr>

610

</table>

611

</div>

612

613

614

<p>

615

Delete an entry in a dictionary.

616

<p>

617

<dl compact><dt><b>Parameters:</b></dt><dd>

618

619

<tr><td valign="top"></td><td valign="top"><em>ini</em> </td><td>Dictionary to modify </td></tr>

620

<tr><td valign="top"></td><td valign="top"><em>entry</em> </td><td>Entry to delete (entry name) </td></tr>

621

</table>

622

</dl>

623

<dl class="return" compact><dt><b>Returns:</b></dt><dd>void</dd></dl>

624

If the given entry can be found, it is deleted from the dictionary.

625

</div>

626

</div><p>

627

628

</body>

629

</html>