package com_maroontress_libcgi_request

class Map

#define com_maroontress_libcgi_request_Map_IMPORT
#include <com/maroontress/libcgi/request/Map.h>
キーから値を取得するマップです。キーと値は文字列になります。

Struct Summary

struct Map
          マップの実体となる構造体です。

Method Summary

 struct Map * Map_create(void)
          空のマップを生成します。
 void Map_free(struct Mapmap)
          マップを解放します。
 char * Map_get(struct Mapmap, const char * key)
          キーに対応する値を取得します。
 int Map_put(struct Mapmap, const char * key, const char * value)
          キーに対応する値を設定します。

Struct Detail

struct Map

マップの実体となる構造体です。

Method Detail

Map_create

struct Map * Map_create( void)
空のマップを生成します。

戻り値が参照するオブジェクトはMap_free()で解放しなければなりません。

Returns:
マップ

Map_free

void Map_free( struct Mapmap)
マップを解放します。

mapNULLのときはなにもしません。呼び出し後はmapが参照するオブジェクトを参照してはなりません。

Parameters:
map - マップ

Map_get

char * Map_get( struct Mapmap,
const char * key)
キーに対応する値を取得します。

keyをキーとする値をmapから取得します。成功した場合は値となる文字列を返します。指定したキーが存在しない場合はNULLを返します。

戻り値が参照するオブジェクトはmapを解放するまで有効です。戻り値が参照するオブジェクトを変更、解放してはなりません。

同じキーに複数の値を設定した場合、いずれかの値が返ります。

Parameters:
map - マップ
key - キーとなる文字列
Returns:
値となる文字列、またはNULL

Map_put

int Map_put( struct Mapmap,
const char * key,
const char * value)
キーに対応する値を設定します。

keyをキーとするvaluemapに設定します。成功した場合は0、そうでなければ−1を返します。

Parameters:
map - マップ
key - キーとなる文字列
value - 値となる文字列
Returns:
成功した場合は0、そうでなければ−1