IPWorks Cloud 2020 C++ Builder Edition

Questions / Feedback?

RemoteId Property

Selects a remote resource by Id.

Syntax

__property String RemoteId = { read=FRemoteId, write=FSetRemoteId };

Default Value

""

Remarks

This property selects a remote file or folder resource to operate against using its resource Id.

Remote Id and Path Notes

Keep the following things in mind when setting the RemoteId and/or RemotePath properties:

  • If both RemoteId and RemotePath are set, RemoteId is used.
  • The Id or path provided must always be for a resource that resides in the drive currently selected by Drive.
  • Some methods operate against only file or only folder resources; while others can operate against either one. Calling a method while RemoteId/RemotePath is set to the Id/path of a resource whose type is unsupported will cause the server to return an error; use the table below to determine which resource types each method supports.

    Method Name Files Folders
    CopyResource X X
    CreateFolder - X
    CreateLink X X
    DeleteResource X X
    DownloadFile X -
    GetResourceInfo X X
    ListResources - X
    MoveResource X X
    Search - X
    UpdateResource X X
    UploadFile - X

    Key: X = Supported; - = Not supported.

  • Methods that support only folder resources can also operate against the root of the currently selected drive, just clear both RemoteId and RemotePath.
  • Some methods may have other restrictions, refer to each one for more information.

Note: The rules regarding acceptable resource types still apply if using the RelativePath configuration setting in tandem with this property. That is, ensure that the resource that the relative path resolves to is of an acceptable type.

This property is not available at design time.

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 C++ Builder Edition - Version 20.0 [Build 8265]