~ubuntu-branches/ubuntu/natty/gnome-keyring/natty

void <a class="link" href="gnome-keyring-gnome-keyring-find.html#gnome-keyring-found-free" title="gnome_keyring_found_free ()">gnome_keyring_found_free</a> (<a class="link" href="gnome-keyring-gnome-keyring-find.html#GnomeKeyringFound" title="GnomeKeyringFound">GnomeKeyringFound</a> *found);

void <a class="link" href="gnome-keyring-gnome-keyring-find.html#gnome-keyring-found-list-free" title="gnome_keyring_found_list_free ()">gnome_keyring_found_list_free</a> (<a

href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"

>GList</a> *found_list);

href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"

>gpointer</a> <a class="link" href="gnome-keyring-gnome-keyring-find.html#gnome-keyring-find-items" title="gnome_keyring_find_items ()">gnome_keyring_find_items</a> (<a class="link" href="gnome-keyring-gnome-keyring-item-info.html#GnomeKeyringItemType" title="enum GnomeKeyringItemType">GnomeKeyringItemType</a> type,

<a class="link" href="gnome-keyring-gnome-keyring-attributes.html#GnomeKeyringAttributeList" title="GnomeKeyringAttributeList">GnomeKeyringAttributeList</a> *attributes,

<a class="link" href="gnome-keyring-gnome-keyring-generic-callbacks.html#GnomeKeyringOperationGetListCallback" title="GnomeKeyringOperationGetListCallback ()">GnomeKeyringOperationGetListCallback</a> callback,

href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"

>gpointer</a> data,

href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"

>GDestroyNotify</a> destroy_data);

href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"

>gpointer</a> <a class="link" href="gnome-keyring-gnome-keyring-find.html#gnome-keyring-find-itemsv" title="gnome_keyring_find_itemsv ()">gnome_keyring_find_itemsv</a> (<a class="link" href="gnome-keyring-gnome-keyring-item-info.html#GnomeKeyringItemType" title="enum GnomeKeyringItemType">GnomeKeyringItemType</a> type,

href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"

>gpointer</a> data,

href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"

>GDestroyNotify</a> destroy_data,

...);

<a class="link" href="gnome-keyring-gnome-keyring-result.html#GnomeKeyringResult" title="enum GnomeKeyringResult">GnomeKeyringResult</a> <a class="link" href="gnome-keyring-gnome-keyring-find.html#gnome-keyring-find-items-sync" title="gnome_keyring_find_items_sync ()">gnome_keyring_find_items_sync</a> (<a class="link" href="gnome-keyring-gnome-keyring-item-info.html#GnomeKeyringItemType" title="enum GnomeKeyringItemType">GnomeKeyringItemType</a> type,

<a class="link" href="gnome-keyring-gnome-keyring-attributes.html#GnomeKeyringAttributeList" title="GnomeKeyringAttributeList">GnomeKeyringAttributeList</a> *attributes,

href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"

>GList</a> **found);

<a class="link" href="gnome-keyring-gnome-keyring-result.html#GnomeKeyringResult" title="enum GnomeKeyringResult">GnomeKeyringResult</a> <a class="link" href="gnome-keyring-gnome-keyring-find.html#gnome-keyring-find-itemsv-sync" title="gnome_keyring_find_itemsv_sync ()">gnome_keyring_find_itemsv_sync</a> (<a class="link" href="gnome-keyring-gnome-keyring-item-info.html#GnomeKeyringItemType" title="enum GnomeKeyringItemType">GnomeKeyringItemType</a> type,

href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"

>GList</a> **found,

...);

</pre>

</div>

<a name="gnome-keyring-gnome-keyring-find.description"></a><h2>Description</h2>

<p>

A find operation searches through all keyrings for items that match the

attributes. The user may have been prompted to unlock necessary keyrings, and

user will have been prompted for access to the items if needed.

</p>

<p>

A find operation may return multiple or zero results.</p>

<p>

</p>

</div>

<a name="gnome-keyring-gnome-keyring-find.details"></a><h2>Details</h2>

<a name="GnomeKeyringFound"></a><h3>GnomeKeyringFound</h3>

<pre class="programlisting">typedef struct {

char *keyring;

guint item_id;

100

GnomeKeyringAttributeList *attributes;

101

char *secret;

102

} GnomeKeyringFound;

103

</pre>

104

<p>

105

</p>

106

</div>

107

<hr>

108

109

<a name="gnome-keyring-found-free"></a><h3>gnome_keyring_found_free ()</h3>

110

<pre class="programlisting">void gnome_keyring_found_free (<a class="link" href="gnome-keyring-gnome-keyring-find.html#GnomeKeyringFound" title="GnomeKeyringFound">GnomeKeyringFound</a> *found);</pre>

111

<p>

112

Free the memory used by a <a class="link" href="gnome-keyring-gnome-keyring-find.html#GnomeKeyringFound" title="GnomeKeyringFound"><span class="type">GnomeKeyringFound</span></a> item.

113

</p>

114

<p>

115

You usually want to use <a class="link" href="gnome-keyring-gnome-keyring-find.html#gnome-keyring-found-list-free" title="gnome_keyring_found_list_free ()"><code class="function">gnome_keyring_found_list_free()</code></a> on the list of

116

results.</p>

117

<p>

118

</p>

119

120

121

122

<td><p><span class="term"><em class="parameter"><code>found</code></em> :</span></p></td>

123

<td> a <a class="link" href="gnome-keyring-gnome-keyring-find.html#GnomeKeyringFound" title="GnomeKeyringFound"><span class="type">GnomeKeyringFound</span></a>

124

</td>

125

</tr></tbody>

126

</table></div>

127

</div>

128

<hr>

129

130

<a name="gnome-keyring-found-list-free"></a><h3>gnome_keyring_found_list_free ()</h3>

131

<pre class="programlisting">void gnome_keyring_found_list_free (<a

132

href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"

133

>GList</a> *found_list);</pre>

134

<p>

135

Free the memory used by the <a class="link" href="gnome-keyring-gnome-keyring-find.html#GnomeKeyringFound" title="GnomeKeyringFound"><span class="type">GnomeKeyringFound</span></a> items in <em class="parameter"><code>found_list</code></em>.</p>

136

<p>

137

</p>

138

139

140

141

<td><p><span class="term"><em class="parameter"><code>found_list</code></em> :</span></p></td>

142

<td> a <a

143

href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"

144

><span class="type">GList</span></a> of <a class="link" href="gnome-keyring-gnome-keyring-find.html#GnomeKeyringFound" title="GnomeKeyringFound"><span class="type">GnomeKeyringFound</span></a>

145

</td>

146

</tr></tbody>

147

</table></div>

148

</div>

149

<hr>

150

151

<a name="gnome-keyring-find-items"></a><h3>gnome_keyring_find_items ()</h3>

152

<pre class="programlisting"><a

153

href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"

154

>gpointer</a> gnome_keyring_find_items (<a class="link" href="gnome-keyring-gnome-keyring-item-info.html#GnomeKeyringItemType" title="enum GnomeKeyringItemType">GnomeKeyringItemType</a> type,

155

<a class="link" href="gnome-keyring-gnome-keyring-attributes.html#GnomeKeyringAttributeList" title="GnomeKeyringAttributeList">GnomeKeyringAttributeList</a> *attributes,

156

157

158

href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"

159

>gpointer</a> data,

160

161

href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"

162

>GDestroyNotify</a> destroy_data);</pre>

163

<p>

164

Searches through all keyrings for items that match the <em class="parameter"><code>attributes</code></em>. The matches

165

are for exact equality.

166

</p>

167

<p>

168

A <a

169

href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"

170

><code class="literal">GList</code></a> of GnomeKeyringFound structures are passed to the <em class="parameter"><code>callback</code></em>. The

171

list and structures are freed after the callback returns.

172

</p>

173

<p>

174

The user may have been prompted to unlock necessary keyrings, and user will

175

have been prompted for access to the items if needed.

176

</p>

177

<p>

178

For a synchronous version of this function see <a class="link" href="gnome-keyring-gnome-keyring-find.html#gnome-keyring-find-items-sync" title="gnome_keyring_find_items_sync ()"><code class="function">gnome_keyring_find_items_sync()</code></a>.</p>

179

<p>

180

</p>

181

182

183

<tbody>

184

<tr>

185

186

<td> The type of items to find.

187

</td>

188

</tr>

189

<tr>

190

<td><p><span class="term"><em class="parameter"><code>attributes</code></em> :</span></p></td>

191

<td> A list of attributes to search for. This cannot be an empty list.

192

</td>

193

</tr>

194

<tr>

195

<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>

196

<td> A callback which will be called when the request completes or fails.

197

</td>

198

</tr>

199

<tr>

200

201

<td> A pointer to arbitrary data that will be passed to the <em class="parameter"><code>callback</code></em>.

202

</td>

203

</tr>

204

<tr>

205

<td><p><span class="term"><em class="parameter"><code>destroy_data</code></em> :</span></p></td>

206

<td> A function to free <em class="parameter"><code>data</code></em> when it's no longer needed.

207

</td>

208

</tr>

209

<tr>

210

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

211

<td> The asychronous request, which can be passed to <a class="link" href="gnome-keyring-gnome-keyring-misc.html#gnome-keyring-cancel-request" title="gnome_keyring_cancel_request ()"><code class="function">gnome_keyring_cancel_request()</code></a>.

212

</td>

213

</tr>

214

</tbody>

215

</table></div>

216

</div>

217

<hr>

218

219

<a name="gnome-keyring-find-itemsv"></a><h3>gnome_keyring_find_itemsv ()</h3>

220

<pre class="programlisting"><a

221

href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"

222

>gpointer</a> gnome_keyring_find_itemsv (<a class="link" href="gnome-keyring-gnome-keyring-item-info.html#GnomeKeyringItemType" title="enum GnomeKeyringItemType">GnomeKeyringItemType</a> type,

223

224

225

href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"

226

>gpointer</a> data,

227

228

href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"

229

>GDestroyNotify</a> destroy_data,

230

...);</pre>

231

<p>

232

Searches through all keyrings for items that match the specified attributes.

233

The matches are for exact equality.

234

</p>

235

<p>

236

The variable argument list should contain a) The attribute name as a null

237

terminated string, followed by b) The attribute type, either

238

<code class="literal">GNOME_KEYRING_ATTRIBUTE_TYPE_STRING</code> or <code class="literal">GNOME_KEYRING_ATTRIBUTE_TYPE_UINT32</code>

239

and then the c) attribute value, either a character string, or 32-bit

240

unsigned int. The list should be terminated with a NULL.

241

</p>

242

<p>

243

A <a

244

href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"

245

><code class="literal">GList</code></a> of GnomeKeyringFound structures are passed to the <em class="parameter"><code>callback</code></em>. The

246

list and structures are freed after the callback returns.

247

</p>

248

<p>

249

The user may have been prompted to unlock necessary keyrings, and user will

250

have been prompted for access to the items if needed.

251

</p>

252

<p>

253

For a synchronous version of this function see <a class="link" href="gnome-keyring-gnome-keyring-find.html#gnome-keyring-find-itemsv-sync" title="gnome_keyring_find_itemsv_sync ()"><code class="function">gnome_keyring_find_itemsv_sync()</code></a>.</p>

254

<p>

255

</p>

256

257

258

<tbody>

259

<tr>

260

261

<td> The type of items to find.

262

</td>

263

</tr>

264

<tr>

265

<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>

266

<td> A callback which will be called when the request completes or fails.

267

</td>

268

</tr>

269

<tr>

270

271

<td> A pointer to arbitrary data that will be passed to the <em class="parameter"><code>callback</code></em>.

272

</td>

273

</tr>

274

<tr>

275

<td><p><span class="term"><em class="parameter"><code>destroy_data</code></em> :</span></p></td>

276

<td> A function to free <em class="parameter"><code>data</code></em> when it's no longer needed.

277

</td>

278

</tr>

279

<tr>

280

281

<td>

282

</td>

283

</tr>

284

<tr>

285

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

286

287

</td>

288

</tr>

289

</tbody>

290

</table></div>

291

</div>

292

<hr>

293

294

<a name="gnome-keyring-find-items-sync"></a><h3>gnome_keyring_find_items_sync ()</h3>

295

<pre class="programlisting"><a class="link" href="gnome-keyring-gnome-keyring-result.html#GnomeKeyringResult" title="enum GnomeKeyringResult">GnomeKeyringResult</a> gnome_keyring_find_items_sync (<a class="link" href="gnome-keyring-gnome-keyring-item-info.html#GnomeKeyringItemType" title="enum GnomeKeyringItemType">GnomeKeyringItemType</a> type,

296

<a class="link" href="gnome-keyring-gnome-keyring-attributes.html#GnomeKeyringAttributeList" title="GnomeKeyringAttributeList">GnomeKeyringAttributeList</a> *attributes,

297

298

href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"

299

>GList</a> **found);</pre>

300

<p>

301

Searches through all keyrings for items that match the <em class="parameter"><code>attributes</code></em> and <em class="parameter"><code>type</code></em>.

302

The matches are for exact equality.

303

</p>

304

<p>

305

A <a

306

href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"

307

><code class="literal">GList</code></a> of GnomeKeyringFound structures is returned in <em class="parameter"><code>found</code></em>. The list may

308

have zero items if nothing matched the criteria. The list should be freed

309

using <a class="link" href="gnome-keyring-gnome-keyring-find.html#gnome-keyring-found-list-free" title="gnome_keyring_found_list_free ()"><code class="function">gnome_keyring_found_list_free()</code></a>.

310

</p>

311

<p>

312

The user may have been prompted to unlock necessary keyrings, and user will

313

have been prompted for access to the items if needed.

314

</p>

315

<p>

316

For an asynchronous version of this function see <a class="link" href="gnome-keyring-gnome-keyring-find.html#gnome-keyring-find-items" title="gnome_keyring_find_items ()"><code class="function">gnome_keyring_find_items()</code></a>.</p>

317

<p>

318

</p>

319

320

321

<tbody>

322

<tr>

323

324

<td> The type of items to find.

325

</td>

326

</tr>

327

<tr>

328

<td><p><span class="term"><em class="parameter"><code>attributes</code></em> :</span></p></td>

329

<td> A list of attributes to search for. This cannot be an empty list.

330

</td>

331

</tr>

332

<tr>

333

<td><p><span class="term"><em class="parameter"><code>found</code></em> :</span></p></td>

334

<td> The location to return a list of <a class="link" href="gnome-keyring-gnome-keyring-find.html#GnomeKeyringFound" title="GnomeKeyringFound"><span class="type">GnomeKeyringFound</span></a> pointers.

335

</td>

336

</tr>

337

<tr>

338

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

339

<td> <code class="literal">GNOME_KEYRING_RESULT_OK</code> if the operation was succcessful or

340

an error result otherwise.

341

</td>

342

</tr>

343

</tbody>

344

</table></div>

345

</div>

346

<hr>

347

348

<a name="gnome-keyring-find-itemsv-sync"></a><h3>gnome_keyring_find_itemsv_sync ()</h3>

349

<pre class="programlisting"><a class="link" href="gnome-keyring-gnome-keyring-result.html#GnomeKeyringResult" title="enum GnomeKeyringResult">GnomeKeyringResult</a> gnome_keyring_find_itemsv_sync (<a class="link" href="gnome-keyring-gnome-keyring-item-info.html#GnomeKeyringItemType" title="enum GnomeKeyringItemType">GnomeKeyringItemType</a> type,

350

351

href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"

352

>GList</a> **found,

353

...);</pre>

354

<p>

355

Searches through all keyrings for items that match the <em class="parameter"><code>attributes</code></em> and <em class="parameter"><code>type</code></em>.

356

The matches are for exact equality.

357

</p>

358

<p>

359

The variable argument list should contain a) The attribute name as a null

360

terminated string, followed by b) The attribute type, either

361

<code class="literal">GNOME_KEYRING_ATTRIBUTE_TYPE_STRING</code> or <code class="literal">GNOME_KEYRING_ATTRIBUTE_TYPE_UINT32</code>

362

and then the c) attribute value, either a character string, or 32-bit

363

unsigned int. The list should be terminated with a NULL.

364

</p>

365

<p>

366

A <a

367

href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"

368

><code class="literal">GList</code></a> of GnomeKeyringFound structures is returned in <em class="parameter"><code>found</code></em>. The list may

369

have zero items if nothing matched the criteria. The list should be freed

370

371

</p>

372

<p>

373

The user may have been prompted to unlock necessary keyrings, and user will

374

have been prompted for access to the items if needed.

375

</p>

376

<p>

377

378

<p>

379

</p>

380

381

382

<tbody>

383

<tr>

384

385

<td> The type of items to find.

386

</td>

387

</tr>

388

<tr>

389

<td><p><span class="term"><em class="parameter"><code>found</code></em> :</span></p></td>

390

391

</td>

392

</tr>

393

<tr>

394

395

<td>

396

</td>

397

</tr>

398

<tr>

399

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

400

<td> <code class="literal">GNOME_KEYRING_RESULT_OK</code> if the operation was succcessful or

401

an error result otherwise.

402

</td>

403

</tr>

404

</tbody>

405

</table></div>

406

</div>

407

</div>

408

</div>

409

410

<hr>

411

Generated by GTK-Doc V1.11</div>

412

</body>

413

</html>

Older »