SignatureProvider.GetProviderDetail method (Office)

Queries the signature provider add-in for various details.

Syntax

expression.GetProviderDetail(sigprovdet)

expression An expression that returns a SignatureProvider object.

Parameters

Name Required/Optional Data type Description
sigprovdet Required SignatureProviderDetail Contains an enumerated value representing the type of information to query the add-in for.

Return value

Variant

Remarks

The SignatureProvider object is used exclusively in custom signature provider add-ins. This method is used to query the add-in for three pieces of information:

  • What hash algorithm does the add-in support?

  • Is the add-in only a user interface (UI) or does it support hashing and verification? If True is returned, Microsoft Office does not call the add-in to hash or verify, only to display the UI.

  • What URL should the add-in provide for users if they are missing the signature add-in?

Example

The following example, written in C#, shows the implementation of the GetProviderDetail method in a custom signature provider project.

 public object GetProviderDetail(SignatureProviderDetail sigProvDetail) 
 { 
 switch (sigProvDetail) 
 { 
 case Microsoft.Office.Core.SignatureProviderDetail.sigprovdetHashAlgorithm: 
 return this.HashAlgorithmIdentifier; 
 
 case Microsoft.Office.Core.SignatureProviderDetail.sigprovdetUIOnly: 
 return false; 
 
 case Microsoft.Office.Core.SignatureProviderDetail.sigprovdetUrl: 
 return this.ProviderUrl; 
 
 default: 
 return null; 
 } 
 } 

Note

Signature providers are implemented exclusively in custom COM add-ins and cannot be implemented in Microsoft Visual Basic for Applications (VBA).

See also

Support and feedback

Have questions or feedback about Office VBA or this documentation? Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.