SendCustomRequest Method

Sends a custom request to the Azure Blob Storage service.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int SendCustomRequest(const char* lpszHttpMethod, const char* lpszBlob, const char* lpszRequestBody);

Unicode (Windows)
INT SendCustomRequest(LPCWSTR lpszHttpMethod, LPCWSTR lpszBlob, LPCWSTR lpszRequestBody);

- (void)sendCustomRequest:(NSString*)httpMethod :(NSString*)blob :(NSString*)requestBody;

#define MID_AZUREBLOB_SENDCUSTOMREQUEST 31

IPWORKSCLOUD_EXTERNAL int IPWORKSCLOUD_CALL IPWorksCloud_AzureBlob_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method can be used to send arbitrary requests to the Azure Blob Storage service.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• DELETE

The Blob and RequestBody parameters may be empty if not needed.

Usage

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, using the following:
   • UseSSL
   • Account (must be non-empty)
   • Container (if non-empty)
   • Blob (if non-empty)
   • Snapshot (if both it and Blob are non-empty)
   • QueryParam*
2. Adds request headers from:
   • APIVersion
   • LeaseId (if non-empty)
   • IfMatch (if non-empty)
   • OtherHeaders
3. Authenticates the request using Authorization (if non-empty), or AccessKey (in which case the request is signed).
4. Sends the request, including RequestBody if non-empty.
5. Stores the response headers in the ParsedHeader* properties; and the response body in the stream specified using SetDownloadStream, the specified LocalFile, or BlobData (using the same logic as GetBlob).

If the response body is XML data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)