S3_Close Description
S3_Close();
Closes the current Amazon Simple Storage Service.
S3_DownloadFile Description
S3_DownloadFile(
char *S3ObjectKey,
char *Filename
);
Downloads a file from the Amazon Simple Storage Service without opening it.
Parameters
char *S3ObjectKey File object key in the Amazon Simple Storage Service.
char *Filename The path and the name of the file.
S3_ListFilesToClipboard Description
S3_ListFilesToClipboard();
Copies a list of nd2 files into clipboard.
S3_LoadFile Description
S3_LoadFile(
char *S3ObjectKey
);
Opens a file from the Amazon Simple Storage Service as a current document.
Parameters
char *S3ObjectKey File object key in the Amazon Simple Storage Service.
S3_Login Description
S3_Login(
char *S3Region,
char *S3AccessKey,
char *S3SecretKey,
char s3bucket *S3Endpoint,
char *S3Prefix,
int S3KeepLoggedIn
);
To login into the Amazon S3 storage fill in your region, access-key-id, secret-access-key and bucket. The endpoint is not needed for S3 (can be used with MinIO for example). Fill in the common prefix, e.g. “TEST/” to use in the bucket (or an empty string) it is always prepended to the object key. If KeepLoggedIn is set to 1 the login data will be stored encrypted per user and will be automatically logged in when calling other functions.
Parameters
char *S3Region Amazon Simple Storage Service region, e.g.: “eu-west-1”.
char *S3AccessKey Amazon Simple Storage Service access key.
char *S3SecretKey Amazon Simple Storage Service password key.
char s3bucket *Amazon Simple Storage Service bucket address.
char *S3Endpoint Amazon Simple Storage Service endpoint (empty for Amazon).
char *S3Prefix Amazon Simple Storage Service prefix, e.g.: “TEST/”
int S3KeepLoggedIn Remembering of the logging to the Amazon Simple Storage Service.
0 | Do not remember logging in. |
1 | Remember logging in. |
S3_Logout Description
S3_Logout();
Logs out from the Amazon Simple Storage Service.
S3_Open Description
S3_Open(
char s3bucket *S3Prefix
);
Opens the specified Amazon Simple Storage Service.
Parameters
char s3bucket *Amazon Simple Storage Service bucket address.
char *S3Prefix Amazon Simple Storage Service prefix, e.g.: “TEST/”
S3_RemoveFile Description
S3_RemoveFile(
char *S3ObjectKey
);
Removes a file from the Amazon Simple Storage Service.
Parameters
char *S3ObjectKey File object key in the Amazon Simple Storage Service.
S3_SaveFile Description
S3_SaveFile(
char *S3ObjectKey
);
Saves the currently opened file to the Amazon Simple Storage Service so that single nd2 chunks are saved as objects.
Parameters
char *S3ObjectKey File object key in the Amazon Simple Storage Service.
S3_SetPrefix Description
S3_SetPrefix(
char *S3Prefix,
int S3KeepLoggedIn
);
Is used to change the common prefix and whether to store the new one into defaults.
Parameters
char *S3Prefix Amazon Simple Storage Service prefix, e.g.: “TEST/”
int S3KeepLoggedIn Remembering of the logging to the Amazon Simple Storage Service.
0 | Do not remember logging in. |
1 | Remember logging in. |
S3_UploadFile Description
S3_UploadFile(
char *S3ObjectKey,
char *Filename
);
Uploads a file to the Amazon Simple Storage Service.
Parameters
char *S3ObjectKey File object key in the Amazon Simple Storage Service.
char *Filename The path and the name of the file.