LINK11系関数

cL11ChangedState
L11AsyncSendPersonaMessage
L11CloseHandle
L11GetFriends
L11GetOnlineState
L11GetOwnSignInState
L11GetPersonas
L11GetPID
L11GetResponseGetOnlineState
L11GetResponseGetPersonas
L11GetResponseInt
L11GetResponseStr
L11SendPersonaMessage
L11WaitResponse

void cL11ChangedState(
  string PID,
  int state_type,
  string state_str,
  string name )
[2.00以降]

機能 メンバーリストに登録されたメンバーの状態・表示名が変わると 割り込みでコールバックされます.
引数
PID 状態・表示名が変化したメンバーのキャラリナID
state_type メンバーの現在の状態
state_str メンバーの現在の状態を表す文字列
name メンバーの現在のニックネーム
戻り値

なし

説明

メンバーリストに登録されたメンバーの状態・表示名が変わると 割り込みでコールバックされます. 実行中の全てのキャラクターで同時に呼ばれます.

state_type引数についてはL11GetResponseGetOnlineStateを参照してください.

このカテゴリのトップ| カテゴリ別関数一覧| 関数名一覧

int L11AsyncSendPersonaMessage(
  int& handle,
  string PID,
  string persona,
  string message )
[2.00以降]

機能 キャラクター間通信でメッセージを非同期的に送信します.
引数
handle ハンドルをセットするリファレンス
PID 宛先ユーザーのキャラリナID
persona 宛先のキャラクター型名
message 送信すべき文字列
戻り値
1 成功
1以外 失敗
説明

PIDで指定されたユーザーのキャラクターpersonaにメッセージを送ります. 相手に届くと,相手のキャラクターで割り込みcL11ReceivePersonaMessageが呼ばれます. 相手がオフラインならそのメッセージはサーバに溜まり,相手がオンラインになった時に送られます.

persona引数については,cAppearedを参照してください.

成功すると,問い合わせ要求に対応したハンドルをhandle引数に書 き込みます. 失敗した場合はhandle引数を変更しません.

成功はメッセージをサーバに送信したことを保証しますが,相手側に届いたことを保証するものではありません. 相手側に届いたことを知る必要がある場合は, L11SendPersonaMessageを使用してください.

メッセージがサーバに受理されたかを知るには,L11WaitResponse関数にhandleを指定して呼び出します.

サーバに多量のメッセージが溜まった場合,あるいは相手が長期にわたりオンラインにならない場合は, サーバに溜まった古いメッセージが削除されることがあります.

このカテゴリのトップ| カテゴリ別関数一覧| 関数名一覧

int L11CloseHandle(   int handle )[2.00以降]

機能 発行されたハンドルを破棄します.
引数
handle破棄するハンドル
戻り値
1成功
-1以下失敗
説明 handle引数で指定されたハンドルを破棄します.
このカテゴリのトップ| カテゴリ別関数一覧| 関数名一覧

int L11GetFriends(   string friends[] )[2.00以降]

機能 メンバーリストに登録されたメンバーのキャラリナIDを返します.
引数
friends[]メンバーのキャラリナIDを書き込む配列
戻り値
0以上friends配列に書き込んだキャラリナIDの数
-1取得に失敗
説明

メンバーリストに登録されたメンバーのキャラリナIDを返します. この関数は,メンバーリストをサーバからではなく,クライアントから 取得します.従って,サーバのメンバーリストと一部不整合が起こる可能性があります.

Chararina(キャラリナ)を起動してからサインインするまでの間は,取得に失敗します.

このカテゴリのトップ| カテゴリ別関数一覧| 関数名一覧

int L11GetOnlineState(
  int& handle,
  string PID )
[2.00以降]

機能 指定されたユーザーの状態をサーバに問い合わせます.
引数
handleハンドルをセットするリファレンス
PID問い合わせるユーザーのキャラリナID
戻り値
1成功
-1以下失敗
説明 PID引数で指定されたユーザーの状態をサーバに問い合わせる要求を 出します.問い合わせの開始に成功すると1を返します.このとき, 要求に対して発行されたハンドルをhandle引数にセットします.失敗 すると負値を返します.このときhandle引数は変更されません.
このカテゴリのトップ| カテゴリ別関数一覧| 関数名一覧

int L11GetOwnSignInState( )[2.00以降]

機能 Chararinaユーザーのサインイン状態を取得します.
引数

なし

戻り値
0サインアウト
1サインイン
-1サインイン中
その他エラー
このカテゴリのトップ| カテゴリ別関数一覧| 関数名一覧

int L11GetPersonas(
  int& handle,
  string PID )
[2.00以降]

機能 指定されたユーザーが起動している全てのキャラクターの識別名を問い合 わせます.
引数
handle この要求に対応するハンドルをセットするリファレンス
PID 問い合わせるユーザーのキャラリナID
戻り値
1成功
-1以下失敗
説明

成功すると,問い合わせ要求に対応したハンドルをhandle引数に書 き込みます.失敗した場合はhandle引数を変更しません.

このカテゴリのトップ| カテゴリ別関数一覧| 関数名一覧

string L11GetPID( )[2.00以降]

機能 自分のキャラリナIDを返します.
引数

なし

戻り値
自分のキャラリナID
このカテゴリのトップ| カテゴリ別関数一覧| 関数名一覧

void L11GetResponseGetOnlineState(
  int handle,
  int& state_type,
  string& state_str,
  string& name )
[2.00以降]

機能 L11GetOnlineStateによる要求の結果を取得します.
引数
handle発行されたハンドル
state_typeユーザーの現在の状態
state_strユーザーの現在の状態を表す文字列
nameユーザーのニックネーム
戻り値

なし

説明

L11GetOnlineStateによる要求の結果を取得します. handle引数にL11GetOnlineStateが発行したハンドルを 指定します.state_type,staet_str,name引数には,ユーザーの 状態,状態を表す文字列,ニックネームを受け取る変数を指定して 関数を呼び出します.

成功した場合のみ,state_type,staet_str,name引数に値を設定します.

state_typeの詳細は次のとおりです.

state_type
1LINK11にサインインしていない,またはhidden状態 にある.
2 LINK11にサインインしているが,IMは受け付けない(自分がこ の状態にあり,PID引数に自分のキャラリナIDを指定した問い合わせたと きにに限られます.)
3LINK11にサインインしているが忙しい
4LINK11にサインインしている

この関数を呼ぶ前に,必ずL11WaitResponseが1を返すことを確認して下さい.

このカテゴリのトップ| カテゴリ別関数一覧| 関数名一覧

void L11GetResponseGetPersonas(
  int handle,
  string persona[] )
[2.00以降]

機能 L11GetPersonasによる要求の結果を取得します.
引数
handle 発行されたハンドル
persona[] キャラクター名を書き込む配列
戻り値

なし

説明

成功すると,persona配列の要素を全て削除してから,得られたペル ソナの名前をセットします.失敗した場合はpersona配列を変更せず に終了します.

この関数を呼ぶ前に,必ずL11WaitResponseが1を返すことを確認して下さい.

このカテゴリのトップ| カテゴリ別関数一覧| 関数名一覧

int L11GetResponseInt(   int handle )[2.00以降]

機能 Link11通信要求の結果をint型で返します.
引数
handleハンドル
戻り値
通信要求の結果
説明

この関数の戻り値は,handleを生成した関数に依存します.

このカテゴリのトップ| カテゴリ別関数一覧| 関数名一覧

string L11GetResponseStr(   int handle )[2.00以降]

機能 Link11通信要求の結果をstring型で返します.
引数
handleハンドル
戻り値
通信要求の結果
説明

この関数の戻り値は,handleを生成した関数に依存します.

このカテゴリのトップ| カテゴリ別関数一覧| 関数名一覧

int L11SendPersonaMessage(
  int& handle,
  string PID,
  string persona,
  string message )
[2.00以降]

機能 キャラクター間通信でメッセージを同期的に送信します.
引数
handle ハンドルをセットするリファレンス
PID 宛先ユーザーのキャラリナID
persona 宛先のキャラクター型名
message 送信すべき文字列
戻り値
1 成功
1以外 失敗
説明

PIDで指定されたユーザーのキャラクターpersonaにメッセージを送ります. 相手に届くと,相手のキャラクターで割り込みcL11ReceivePersonaMessageが呼ばれます. 相手がオフラインなら,そのメッセージは破棄されます.

persona引数については,cAppearedを参照してください.

成功すると,要求に対応したハンドルをhandle引数に書 き込みます. 失敗した場合はhandle引数を変更しません.

成功しても,相手側で割り込みがかかったことが保証される訳ではありません. しかしL11WaitResponse関数にhandleを渡して戻り値1が得られたなら, 相手側で割り込みがかかったことが保証されます.

このカテゴリのトップ| カテゴリ別関数一覧| 関数名一覧

int L11WaitResponse(
  int handle,
  int timeout )
[2.00以降]

機能 LINK11通信要求の結果が戻ってくるまでまたは指定された時間だけ, 待機します.
引数
handle LINK11通信要求関数で得られたハンドル
timeout タイムアウトまでの時間[ms]
戻り値
1結果が戻ってきた
-8PIDで指定されたユーザーがいない
-13handleが不正
-24タイムアウト
-40相手がオフラインだった
-71L11SendPersonaMessageで,宛先キャラクタが起動していなかった
-72L11SendPersonaMessageで,宛先キャラクタは割り込みを禁止していた
-73L11SendPersonaMessageで,宛先キャラクタはコールバック関数を実装していなかった
その他の値その他のエラー
説明

timeout引数で指定された待機時間が経過するか,handle引数で指 定されるLINK11通信要求の結果が戻ってくるまで待機します. handle引数には通信要求をだしたときに発行されたハンドルを指定 します.timeout引数の単位は[ms]です.0[ms]の場合は待機せずに 関数を終了します.

待機時間が経過して尚結果が戻ってこない場合は-24(タイムアウト) を返します.不正なハンドルを指定した場合は,待機せずに-13を返 します.

このカテゴリのトップ| カテゴリ別関数一覧| 関数名一覧