SendCustomRequest Method

Sends a custom request to the server.

Syntax

• C++
• Objective-C
• C

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

Unicode (Windows)
INT SendCustomRequest(LPCWSTR lpszHttpMethod, LPCWSTR lpszPath);

- (void)sendCustomRequest:(NSString*)httpMethod :(NSString*)path;

#define MID_AZUREKEYS_SENDCUSTOMREQUEST 18

CLOUDKEYS_EXTERNAL int CLOUDKEYS_CALL CloudKeys_AzureKeys_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 server.

Valid values for HttpMethod are:

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

Path is optional, and if non-empty must be specified without a leading forward slash (/).

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

1. Builds a request URL, including query parameters, based on the following:
   • The base URL https://{Vault}.vault.azure.net/keys, where {Vault} is Vault.
   • The specified Path, if any.
   • An api-version query parameter whose value is APIVersion.
   • All query parameters from QueryParam*.
2. Adds an Authorization header with the value specified by Authorization.
3. Adds any request headers from OtherHeaders.
4. Adds any request body supplied via the stream specified using SetInputStream, the specified InputFile, or InputData.
5. Sends the request to the server.
6. Stores the response headers in the ParsedHeader* properties; and the response body in the stream specified using SetOutputStream, the specified OutputFile, or OutputData.

If the response body is JSON 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.)