registration_script

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

Executes the specified custom registration script.

  
      [ registration_script(   
   script   
) ]  

Parameters

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.

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.

The following code specifies that the component has a registry script called cpp_attr_ref_registration_script.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 "cpp_attr_ref_registration_script.rgs"  
// create sample .RGS file "cpp_attr_ref_registration_script.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 {};  

Attribute Context

Applies toclass, struct
RepeatableNo
Required attributesOne or more of the following: coclass, progid, or vi_progid.
Invalid attributesNone

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

COM Attributes
Class Attributes
rdx
Attributes Samples

Show: