EssRenameObject

サーバーまたはクライアント・オブジェクト・システム上の既存のオブジェクトの名前を変更します。

構文

            ESS_FUNC_M EssRenameObject (
            hCtx, ObjType, AppName, DbName,
OldName, NewName
            );

パラメータ	データ型	説明
hCtx	ESS_HCTX_T	APIコンテキスト・ハンドル。EssCreateLocalContextによって戻されたローカル・コンテキスト・ハンドルの場合もあります。
ObjType	ESS_OBJTYPE_T	オブジェクト・タイプ(単一のタイプのみ)。使用可能な値のリストは、ビットマスク・データ型(C)を参照してください。
AppName	ESS_STR_T	アプリケーション名。
DbName	ESS_STR_T	データベース名。NULLの場合は、アプリケーション・サブディレクトリを使用します。
OldName	ESS_STR_T	名前を変更するオブジェクトの古い名前。
NewName	ESS_STR_T	オブジェクトの新しい名前。オブジェクト名の制限を参照してください。

備考

オブジェクト名を変更するには、そのオブジェクトがロックされていないことと、新しいオブジェクトが存在していないことが必要です。
アウトライン・オブジェクトおよびLROオブジェクトの名前は、変更できません。
関連付けられているアウトラインを含めてデータベース名を変更するには、EssRenameDatabaseを使用します。
異なるアプリケーションやデータベースではオブジェクトの名前を変更できません。別のアプリケーションやデータベースにオブジェクトをコピーするには、EssCopyObjectを使用します。

戻り値

なし。

アクセス

この関数を使用するには、呼出し元が、オブジェクトが含まれる指定されたアプリケーションまたはデータベースに対してアプリケーション・デザイン権限またはデータベース・デザイン権限(ESS_PRIV_APPDESIGNまたはESS_PRIV_DBDESIGN)を持っている必要があります。

例

         ESS_STS_T 
ESS_RenameObject (ESS_HCTX_T hCtx)   
{
   ESS_STS_T         sts = ESS_STS_NOERR;
   ESS_STR_T         AppName;
   ESS_STR_T         DbName;
   ESS_STR_T         OldName;        
   ESS_STR_T         NewName;       
   ESS_OBJTYPE_T     ObjType;     
   
   AppName    = "Sample";
   DbName     = "Basic";
   OldName    = "Test"; 
   NewName    = "NewTest";
   ObjType    = ESS_OBJTYPE_TEXT; 
   
   sts = EssRenameObject(hCtx, ObjType, AppName,
         DbName, OldName, NewName); 

   if(!sts)
      printf("The Object is renamed.\r\n");
 
   return (sts);
}