package com_maroontress_libcgi_request

class MimePart

#define com_maroontress_libcgi_request_MimePart_IMPORT
#include <com/maroontress/libcgi/request/MimePart.h>
MIMEマルチパート形式のファイルの1パートを表すクラスです。

Struct Summary

struct MimePart
          パートの実体となる構造体です。

Method Summary

 struct MimePart * MimePart_create(FILE * file, const struct FileSegmentsegment)
          MIMEマルチパート形式のファイルの特定の区間からパートを生成します。
 void MimePart_free(struct MimePartmp)
          パートを解放します。
 struct com_maroontress_libcgi_mime_ContentType * MimePart_getContentType(struct MimePartmp)
          コンテンツタイプを取得します。
 struct com_maroontress_libcgi_mime_ContentType * MimePart_getDisposition(struct MimePartmp)
          ディスポジションを取得します。
 char * MimePart_getContent(struct MimePartmp)
          コンテンツを文字列として取得します。
 off_t MimePart_write(struct MimePartmp, union std_io_OutputTube out)
          コンテンツを出力ストリームに書きます。

Struct Detail

struct MimePart

パートの実体となる構造体です。

Method Detail

MimePart_create

struct MimePart * MimePart_create( FILE * file,
const struct FileSegmentsegment)
MIMEマルチパート形式のファイルの特定の区間からパートを生成します。

戻り値が参照するオブジェクトを解放するまでfileが参照するオブジェクトは有効でなければなりません。また、それまでfileが参照するオブジェクトにアクセスしてもいけません。

生成できなかった場合はNULLを返します。

Parameters:
file - ファイル
segment - ファイルの区間
Returns:
パート、またはNULL

MimePart_free

void MimePart_free( struct MimePartmp)
パートを解放します。

生成のときに指定したファイルはクローズされません。

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

Parameters:
mp - パート

MimePart_getContentType

struct com_maroontress_libcgi_mime_ContentType *
          MimePart_getContentType( struct MimePartmp)
コンテンツタイプを取得します。

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

Parameters:
mp - パート
Returns:
コンテンツタイプ

MimePart_getDisposition

struct com_maroontress_libcgi_mime_ContentType *
          MimePart_getDisposition( struct MimePartmp)
ディスポジションを取得します。

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

Parameters:
mp - パート
Returns:
ディスポジション

MimePart_getContent

char * MimePart_getContent( struct MimePartmp)
コンテンツを文字列として取得します。

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

コンテンツを返せない場合はNULLを返します。

Parameters:
mp - パート
Returns:
コンテンツ、またはNULL

MimePart_write

off_t MimePart_write( struct MimePartmp,
union std_io_OutputTube out)
コンテンツを出力ストリームに書きます。

コンテンツをoutに完全に出力できた場合はコンテンツのサイズを返します。そうでなければ−1を返します。その場合、途中までのデータがoutに書かれたかもしれません。

この呼び出しはoutをクローズしません。

Parameters:
mp - パート
out - 出力ストリーム
Returns:
出力したサイズ、または−1