Export (0) Print
Expand All

registration_script

Executes the specified custom registration script.

[ registration_script( 
   script 
) ]

Parameter

script
The full path to a custom registration script (.rgs) file. A value of none, such as script = "none", indicates that the coclass has no registration requirements.

Attribute Context

Applies to class, struct
Repeatable No
Required attributes One or more of the following: coclass, progid, or vi_progid.
Invalid attributes None

For more information about the attribute contexts, see Attribute Contexts.

Remarks

The registration_script C++ attribute executes the custom registration script specified by script. If this attribute is not specified, a standard .rgs file (containing information for registering the component) is used. For more information on .rgs files, see The ATL Registry Component (Registrar).

This attribute requires that the coclass, progid, or vi_progid attribute (or another attribute that implies one of these) also be applied to the same element.

Example

The following code specifies that the component has a registry script called Myrgs.rgs.

// cpp_attr_ref_registration_script.cpp
// compile with: /LD
#define _ATL_ATTRIBUTES
#include "atlbase.h"
#include "atlcom.h"

[module (name="REG")];

[object, uuid("d9cd196b-6836-470b-9b9b-5b04b828e5b0")]
__interface IFace
{
};

// requires "myregs.rgs"
// create sample .RGS file "myregs.rgs" if it does not exist
[ coclass, registration_script(script="cpp_attr_ref_registration_script.rgs"),
  uuid("50d3ad42-3601-4f26-8cfe-0f1f26f98f67")]
class CMyClass:public IFace
{
};

See Also

COM Attributes | Class Attributes | rdx | Attributes Samples

Show:
© 2014 Microsoft