AccessPolicy Property

The canned access policy to apply to a bucket or object.

Syntax

ANSI (Cross Platform)
int GetAccessPolicy();
int SetAccessPolicy(int iAccessPolicy); Unicode (Windows) INT GetAccessPolicy();
INT SetAccessPolicy(INT iAccessPolicy);

Possible Values

PT_PRIVATE(0), 
PT_PUBLIC_READ(1),
PT_PUBLIC_READ_WRITE(2),
PT_AUTHENTICATED_READ(3),
PT_BUCKET_OWNER_READ(4),
PT_BUCKET_OWNER_FULL_CONTROL(5),
PT_NONE(6)
@property (nonatomic,readwrite,assign,getter=accessPolicy,setter=setAccessPolicy:) int accessPolicy;
- (int)accessPolicy;
- (void)setAccessPolicy:(int)newAccessPolicy;

Possible Values

PT_PRIVATE(0), 
PT_PUBLIC_READ(1),
PT_PUBLIC_READ_WRITE(2),
PT_AUTHENTICATED_READ(3),
PT_BUCKET_OWNER_READ(4),
PT_BUCKET_OWNER_FULL_CONTROL(5),
PT_NONE(6)
#define PID_S3CLIENT_ACCESSPOLICY 2

IPWORKSS3_EXTERNAL void* IPWORKSS3_CALL IPWorksS3_S3Client_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSS3_EXTERNAL int IPWORKSS3_CALL IPWorksS3_S3Client_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

0

Remarks

This property specifies the canned access policy that should be applied to a bucket or object when one of the following methods is called:

Valid values are:

ptPrivate (0) (default) Owner gets full control, no one else has access.
ptPublicRead (1) Owner gets full control, everyone else gets read access.
ptPublicReadWrite (2) Owner gets full control, everyone else gets read/write access.
ptAuthenticatedRead (3) Owner gets full control, authenticated users get read access.
ptBucketOwnerRead (4) Only applicable for objects. Object owner gets full control, bucket owner gets read access.
ptBucketOwnerFullControl (5) Only applicable for objects. Both object and bucket owner get full control.
ptNone (6) (Instructs the class to not explicitly set a canned access policy for a bucket or object.)

Note: Most S3-compatible service providers support all of the canned access policies listed above, but some do not, or have additional restrictions. Refer to a provider's documentation for more information.

Data Type

Integer

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