UseVirtualHosting Property

Determines which URL style to use when making requests.

Syntax

ANSI (Cross Platform)
int GetUseVirtualHosting();
int SetUseVirtualHosting(int bUseVirtualHosting);

Unicode (Windows)
BOOL GetUseVirtualHosting();
INT SetUseVirtualHosting(BOOL bUseVirtualHosting);
@property (nonatomic,readwrite,assign,getter=useVirtualHosting,setter=setUseVirtualHosting:) BOOL useVirtualHosting;
- (BOOL)useVirtualHosting;
- (void)setUseVirtualHosting:(BOOL)newUseVirtualHosting;

#define PID_S3CLIENT_USEVIRTUALHOSTING 80

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

TRUE

Remarks

If true (default), virtual-hosted-style URLs will be used to make requests: http://yourbucket.s3.amazonaws.com/yourobject. Note that hosted-style URLs impose more bucket name restrictions due to DNS server naming restrictions. Refer to Amazon's documentation for more information.

If false, path-style URLs will be used to make requests: http://s3.amazonaws.com/yourbucket/yourobject.

Important: When using the spAmazonS3 (0) service provider, keep in mind that Amazon has publicly announced that buckets created after September 30, 2020 will only support virtual-hosted-style URLs. Buckets created on or before September 30, 2020 will continue to support both URL styles.

Note: This property is ignored when ServiceProvider is set to one of the following:

  • spAlibaba (6); Alibaba does not support path-style URLs, only virtual-hosted-style URLs.
  • spOracle (8); Oracle Cloud Object Storage does not support virtual-hosted-style URLs, only path-style URLs.

This property is not available at design time.

Data Type

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