template_descriptor_cc.h File Reference

Defines C-Style TemplateDescriptor functions. More...

#include "mip_cc/common_types_cc.h"
#include "mip_cc/error_cc.h"
#include "mip_cc/mip_macros_cc.h"
#include "mip_cc/result_cc.h"

Include dependency graph for template_descriptor_cc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef mip_cc_handle *	mip_cc_template_descriptor

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_TemplateDescriptor_GetId(const mip_cc_template_descriptor protectionDescriptor
	Gets template ID.
	MIP_CC_API (void) MIP_CC_ReleaseTemplateDescriptor(mip_cc_template_descriptor templateDescriptor)
	Release resources associated with a template descriptor.

Variables
char const int64_t int64_t *	actualNameSize
int64_t *	descriptionSize
mip_cc_guid mip_cc_error *	errorInfo
char *	nameBuffer
char const int64_t	nameBufferSize
int64_t *	nameSize
mip_cc_guid *	templateId

Detailed Description

Defines C-Style TemplateDescriptor functions.

Definition in file template_descriptor_cc.h.

Typedef Documentation

mip_cc_template_descriptor

typedef mip_cc_handle* mip_cc_template_descriptor

Definition at line 42 of file template_descriptor_cc.h.

Function Documentation

MIP_CC_API() [1/2]

MIP_CC_API

(

mip_cc_result

)

const

Gets template ID.

Gets Template description.

Gets size of buffer required to store description.

Gets Template name.

Gets size of buffer required to store name.

Parameters

protectionDescriptor	Descriptor associated with protected content
templateId	[Output] Template ID associated with protection
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

templateDescriptor	Descriptor associated with template
nameSize	[Output] Size of buffer to hold name (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

templateDescriptor	Descriptor associated with template
nameBuffer	[Output] Buffer the name will be copied into.
nameBufferSize	Size (in number of chars) of the nameBuffer.
actualNameSize	[Output] Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If NameBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualNameSize will be set to the minimum required buffer size.

Parameters

templateDescriptor	Descriptor associated with template
descriptionSize	[Output] Size of buffer to hold description (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

templateDescriptor	Descriptor associated with template
descriptionBuffer	[Output] Buffer the description will be copied into.
descriptionBufferSize	Size (in number of chars) of the descriptionBuffer.
actualNameSize	[Output] Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If descriptionBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualDescriptionSize will be set to the minimum required buffer size.

MIP_CC_API() [2/2]

MIP_CC_API

(

void

)

Release resources associated with a template descriptor.

Parameters

templateDescriptor

Template descriptor to be released

Variable Documentation

actualNameSize

char const int64_t int64_t * actualNameSize

Definition at line 90 of file template_descriptor_cc.h.

descriptionSize

int64_t* descriptionSize

Definition at line 104 of file template_descriptor_cc.h.

errorInfo

char const int64_t int64_t mip_cc_error* errorInfo

Definition at line 56 of file template_descriptor_cc.h.

nameBuffer

char * nameBuffer

Definition at line 88 of file template_descriptor_cc.h.

nameBufferSize

char const int64_t nameBufferSize

Definition at line 89 of file template_descriptor_cc.h.

nameSize

int64_t * nameSize

Definition at line 69 of file template_descriptor_cc.h.

templateId

mip_cc_guid* templateId

Definition at line 55 of file template_descriptor_cc.h.