CMNロゴ

ICpx::cpxPilotStart Method

巡回開始時の動作を実装します。

Syntax

BOOL cpxPilotStart(
    ICmnPilot *pICmnPilot
);

Parameters

pICmnPilot

[in] ICmnPilotインターフェースのポインタ
このインターフェースでCMNの機能を利用することが可能です。

Return Value

処理に成功した場合はTRUEを、失敗した場合はFALSEを戻します。

Remarks

巡回時に当該CPXが最初に使用される時にコールされます。
複数のフォルダで同じCPXが使用される場合も最初に使用された時点で一度のみコールされます。
全フォルダ共通でログイン処理を一度のみ行なう場合などに使用します。
全フォルダ共通の処理がない場合はTRUEを戻すのみです。
FALSEを戻すとそれ以降の巡回は中断され、当該CPXを使用する他のフォルダは巡回されません。
ICmnPilot::cmnGetFolderDetailStr.htmlや ICmnPilot::cmnGetFolderDetailInt.html をコールした場合には最初に巡回されたフォルダの情報が取得されます。
ICpxの他のメソッドとは独立したインスタンスでコールされます。

Example

C++

BOOL __stdcall MyCpx::cpxPilotStart (ICmnPilot *pICmnPilot)
{
    // 全フォルダ共通のログイン処理
        :
        
    return TRUE;
}

Delphi

function TMyCpx.cpxPilotStart (pICmnPilot: ICmnPilot): LongBool; stdcall;
begin
    // 全フォルダ共通のログイン処理
        :
        
    Result :=TRUE;
end;


ICpx