VectorScript Declaration:

FUNCTION   GetCheckoutsComment

( VAR comment:STRING ) :BOOLEAN ;

Python:

def  vs.GetCheckoutsComment():

   return (BOOLEAN, comment)

Description:

Get the comment that will be used for checkouts and commits.

説明

チェックアウトと反映に使用されるコメントを返します。

Parameters:

comment

The comment currently being used.

コメント

Result:

True on success, false on failure or not Project Sharing file.

返り値

コメントを取得できた場合TRUEを返します。

See Also:

SetCheckoutsComment  

VectorScript Declaration:

FUNCTION   GetCurrentUserId

( VAR userid:STRING ) :BOOLEAN ;

Python:

def  vs.GetCurrentUserId():

   return (BOOLEAN, userid)

Description:

Get the user id for the current user.

説明

現在のユーザのユーザIDを返します。

Result:

True on success, false on failure

返り値

正しく取得できた場合TRUEを返します。

VectorScript Declaration:

FUNCTION   GetLayerProjectInfo

(   layer :HANDLE;   VAR  masterLayer :BOOLEAN;   VAR  modificationDate :LONGINT;   VAR  checkoutDate :LONGINT;   VAR  checkoutOwner :STRING;   VAR  workingFileId :STRING;   VAR  comment :STRING;   VAR  outOfDate :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetLayerProjectInfo(layer):

   return (BOOLEAN, masterLayer, modificationDate, checkoutDate, checkoutOwner, workingFileId, comment, outOfDate)

Description:

Retrieves values similar to the Layers tab of the Project Sharing dialog.

Timestamps are measured in seconds since January 1, 1904. The value 0 has special meaning depending on the timestamp.

説明

プロジェクト共有ダイアログのレイヤタブにあるものに近い値を返します。

Parameters:

layer	Get status for this Layer	レイヤのハンドル
masterLayer	Is this layer a Master Layer, which requires higher permission to edit?	マスターレイヤかどうか
modificationDate	Timestamp of last commit. 0 means layer is unchanged since initial creation of the Project File.	更新日時の値
checkoutDate	Timestamp of current checkout. 0 means layer is not currently checked out.	チェックアウト日時の値
checkoutOwner	Userid that currently has the layer checked out. Empty string if not checked out.	所有者
workingFileId	Working File Id that currently has the layer checked out. Empty string if not checked out. This is not a filename.	ワーキングファイル固有のID
comment	Comment for the checkout Empty string if not checked out.	チェックアウト時のコメント
outOfDate	If True, there is a newer version of the layer in the Project File that can be brought in with a Refresh.	未更新（変更されたかどうか）

Result:

True on success, false on failure or not Project Sharing file.

返り値

値を取得できた場合TRUEを返します。

See Also:

GetWorkingFileId   GetCurrentUserId  

VectorScript Declaration:

FUNCTION   GetProjectFullPath

( VAR fullPath:STRING ) :BOOLEAN ;

Python:

def  vs.GetProjectFullPath():

   return (BOOLEAN, fullPath)

Description:

Gets the path and filename of the Project File for Project Sharing.

説明

プロジェクト共有用のプロジェクトファイルのパスとファイル名を返します。

Result:

Returns True on success, False on failure or if not Project Sharing

返り値

パスが取得できた場合TRUEを返します。

VectorScript Declaration:

FUNCTION   GetProjectName

( VAR name:STRING ) :BOOLEAN ;

Python:

def  vs.GetProjectName():

   return (BOOLEAN, name)

Description:

Gets the name of the Project File for Project Sharing.

説明

プロジェクト共有のプロジェクトファイルの名前を返します。

Result:

Returns True on success, False on failure or if not Project Sharing

返り値

名前を取得できた場合TRUEを返します。

VectorScript Declaration:

FUNCTION   GetProjectUser

(   userId :STRING;   VAR  fullName :STRING;   VAR  permission :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetProjectUser(userId):

   return (BOOLEAN, fullName, permission)

Description:

For a given userid in the current Project, get their full name and permission level.

Table - Project Sharing Permissions

Permission Level>	Constant
Read Only	1
Layers-Restricted	2
Layers-Unrestricted	3
Layers and Resources	4
Project	5
Administrative	6

説明

現在のプロジェクトのユーザの詳細を返します。

Parameters:

userId	The userid to look up	ユーザID
fullName	The users full name	ユーザのフルネーム
permission	Permission level of the user	権限レベル

Result:

True on success, false on failure or not Project Sharing file.

返り値

正しく取得できた場合TRUEを返します。

See Also:

GetProjectUserNames  

VectorScript Declaration:

FUNCTION   GetProjectUserNames

( VAR userArray:ARRAY ) :BOOLEAN ;

Python:

def  vs.GetProjectUserNames():

   return (BOOLEAN, userArray)

Description:

Get a list of userids that are part of the current project.

説明

現在のプロジェクトの一部であるユーザIDのリストを返します。

Parameters:

userArray

Array of userids as strings

ユーザIDのリスト

Result:

True on success, false on failure or not Project Sharing file.

返り値

リストが取得できた場合TRUEを返します。

See Also:

GetProjectUser  

VectorScript Declaration:

FUNCTION   GetWorkingFileId

( VAR uuid:STRING ) :BOOLEAN ;

Python:

def  vs.GetWorkingFileId():

   return (BOOLEAN, uuid)

Description:

Get the unique id for this Working File. This is not a filename.

Every Working File has a unique identifier. When layers are checked-out, they are reserved for not just a particular user, but also for a particular Working File Id.

The reserved layer can then only be edited in that specific Working File. If the user creates a second Working File and looks at the layer status, it will show in the second Working File as unavailable for checkout or edit, until it has been committed or released in the first file.

The specific value of the Working File Id is not meaningful, so it is not directly visible in any of the dialogs. It is used for the color highlighting of layer names in dialogs that show layer ownership.

説明

ワーキングファイル固有のIDを返します。これはファイル名ではありません。

Parameters:

uuid

Unique id for this working file

ワーキングファイル固有のID

Result:

True on success, false on failure or not Project Sharing file.

返り値

正しく取得できた場合TRUEを返します。

See Also:

GetLayerProjectInfo  

VectorScript Declaration:

FUNCTION   IsAWorkingFile

:BOOLEAN ;

Python:

def  vs.IsAWorkingFile():

   return BOOLEAN

Description:

Returns True if the current document is a Project Sharing Working File. Otherwise returns False.

説明

現在のファイルがプロジェクト共有のワーキングファイルの場合には、TRUEを返します。

Result:

Returns True if the current document is a Project Sharing Working File. Otherwise returns False.

返り値

現在のファイルがプロジェクト共有のワーキングファイルかどうか

VectorScript Declaration:

FUNCTION   IsProjectOffline

:BOOLEAN ;

Python:

def  vs.IsProjectOffline():

   return BOOLEAN

Description:

Checks if current document is a Working File operating in Offline Mode.

Offline Mode is when the Working File is opened and the Project File cannot be found.

説明

現在のファイルがオフラインモードで動作しているかチェックします。

Result:

Returns True if current document is a Working File operating in Offline Mode.
Returns False on failure or not Project Sharing file, or not in Offline Mode.

返り値

現在のファイルがオフラインモードで動作している場合TRUEを返します。

VectorScript Declaration:

FUNCTION   SetCheckoutsComment

( comment:STRING ) :BOOLEAN ;

Python:

def  vs.SetCheckoutsComment(comment):

   return BOOLEAN

Description:

Set the comment that will be used for checkouts and commits.

The Enter Comment dialogs will still be shown when a checkout or commit is done; the dialog will be prepopulated with the comment set with this command.

説明

チェックアウトと反映に使用されるコメントを設定します。

Parameters:

comment

The comment to replace any currently in use.

コメント

Result:

True on success, false on failure or not Project Sharing file.

返り値

コメントを設定できた場合TRUEを返します。

See Also:

GetCheckoutsComment