IOpcSignatureReference::GetType method

Gets a string that indicates the type of the referenced XML element.

Syntax


HRESULT GetType(
  [out, retval] LPCWSTR *type
);

Parameters

type [out, retval]

A string that indicates the type of the referenced XML element.

If the type is not set, the type parameter will be the empty string "".

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return codeDescription
S_OK

The method succeeded.

E_POINTER

The type parameter is NULL.

 

Remarks

This method allocates memory used by the string returned in type. If the method succeeds, call the CoTaskMemFree function to free the memory.

Providing a type for the referenced XML element is optional. If used, the type of the referenced element is serialized in the signature markup as the optional Type attribute value of a Reference element.

The caller can use the type of the referenced element to indicate whether the element is an Object, SignatureProperty, or Manifest element. This identification can aid the caller in processing the reference.

Thread Safety

Packaging objects are not thread-safe.

For more information, see the Getting Started with the Packaging API.

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Msopc.h

IDL

OpcDigitalSignature.idl

See also

IOpcSignatureReference
Overviews
Getting Started with the Packaging API
Packaging API Programming Guide
Reference
Core Packaging Interfaces
Packaging Digital Signature Interfaces
Packaging Interfaces
Packaging API Reference
Packaging API Samples

 

 

Community Additions

ADD
Show: