RcGenerateProxy

The RcGenerateProxy function returns a proxy address as a Unicode string.

Quick Info

RC RcGenerateProxy(
  HANDLE hProxySession,           
  PRECIPIENTINFO pRecipientInfo,  
  INT nRetries,                   
  LPWSTR * ppszProxyAddr          
);
 

Parameters

hProxySession

Input parameter. Handle to the proxy address generation session as returned by RcInitProxies.

pRecipientInfo

Input parameter. The recipient specific details for this recipient.

nRetries

Input parameter. The number of times this function has previously been called with this value for pRecipientInfo.

ppszProxyAddr

Output parameter. The foreign format (proxy) address that is generated. This is a Unicode string of the form "TYPE:VALUE."

Return Values

See Return Values. If RcGenerateProxy returns RC_ERROR, the following can be possible causes:

• The value of the nRetries parameter is too high. RcGenerateProxy cannot generate any more unique proxy addresses.
• The site-specific information is incomplete.
• The per-recipient information is incomplete.

Remarks

You must call RcInitProxies to set up the proxy generation DLL before you call RcGenerateProxy.

RcGenerateProxy uses the pRecipientInfo and nRetries parameters, and the site's proxy information to generate a site-unique recipient proxy address in the addressing format of the foreign address-type.

When you call this function with the same pRecipientInfo parameter but a different nRetries parameter value, RcGenerateProxy returns a different proxy address. Note that the maximum supported value for the nRetries parameter is implementation specific, and can be 0 (zero).

RcGenerateProxy allocates the memory for the ppszProxyAddr parameter. Your program must free this memory by calling the FreeProxy function.

For more information on this function, see Proxy Generation DLL Entry Points.

See Also

CloseProxies, RcInitProxies, RcValidateProxy